Project

pr-notifier

0.0
No commit activity in last 3 years
No release in over 3 years
pr-notifierhatappi/pr-notifierHomepageDocumentationSource CodeBug TrackerWiki
notify GitHub PR in slack
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
3,734
Stars
0
Forks
0
Watchers
1
 Releases
Current version
0.2.0
Total releases
2
First release
2017-12-21
Latest release
2017-12-21
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2017-12-21
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.16.a
rake
~> 10.0
rspec
~> 3.0

Runtime

octokit
>= 0
slack-notifier
>= 0
 Project Readme

pr-notifier

It is a command line tool for notifying slack open pull requests

Installation

Add this line to your application's Gemfile:

gem 'pr-notifier'

And then execute:

$ bundle

Or install it yourself as:

$ gem install pr-notifier

Usage

$ pr-notifier -g [GITHUB_TOKEN] -r hatappi/pr-notifier -w https://hooks.slack.com/services/xxxx/yyyy

CommandLine options

-d, --dry-run                    DRY RUN
-g, --gh-token VALUE             GitHub access token ENV:GH_TOKEN
-r, --repos VALUE                GitHub repositories. separate comma ENV:GH_REPOS
-w, --webhook-url VALUE          slack webhook url ENV:SLACK_WEBHOOK_URL
-c, --channel VALUE              slack channel ENV:SLACK_CHANNEL
-u, --username VALUE             slack username ENV:SLACK_USERNAME
-t, --template VALUE             ERB template for sending to slack ENV:TEMPLATE

Writing a template

pr-notifier' slack template can be changed and use ERB.
pull_requests variables can be used for templates.
pull_requests is an array of instances with the following properties.

- repo: repository name
- repo_url: repository_url
- url: pull request url
- title: pull request title
- body: pull request description
- reviewers: reviewer names
- assignees: assignee names
- creator: pull request creator name
- created_at: day pull request was created

exp.

<%= Time.now %>
<% pull_requests.each do |pr| -%>
  <%= pr.title %>
  <%= pr.body %>
<% end -%>

Contributing

If there is any thing you'd like to contribute or fix, please:

  • Fork the repo
  • Add tests for any new functionality
  • Make your changes
  • Make a pull request

License

The gem is available as open source under the terms of the MIT License.