https://github.com/5t111111/priha
https://github.com/5t111111/priha
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/5t111111/priha
- Owner: 5t111111
- Created: 2016-01-28T14:27:55.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-13T12:13:56.000Z (over 8 years ago)
- Last Synced: 2025-02-14T08:37:53.932Z (4 months ago)
- Language: Ruby
- Size: 7.81 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Priha
If you are a guy who always find something wrong only after sending a pull requset, Priha will help you because Priha lets you examine files' diff between the parent branch and HEAD of the current branch in a real GitHub pull request.
## Installation
```ruby
gem install priha
```
## Usage
**CAUTION:** **DO NOT** use Priha for your secret repostitory. Since Priha pushes some commits to another repository on GitHub, it easily cause a security incident, espacially the branch you set for Priha is "public". Also, Priha removes all branches on the repository specified in config, so you **MUST** create a new repository for this purpose and **DO NOT** use the existing one.
### Create config file
Priha requires a YAML config file (`$HOME/.priha_config.yml` or `$USERPROFILE\.priha_config.yml` for Windows) where your GitHub information is set like the followings.
```yaml
username:
repo:
parent_branch: (optional)
access_token: (optional)
```
Note that you can specify parent_branch by passing that name as an argument, and access_token will be overwritten by "GITHUB_ACCESS_TOKEN" environment variable when exists.
### Let's see files' diff on a GitHub pull request
Simply run `priha` when you are in the topic branch which you want to diff with the parent branch.
``` text
$ priha
```
Or you can specify the parent branch by passing it as an argument.
``` text
$ priha develop
```
Then you can see files' diff in your web browser (OS X only), or copy/paste displayed URL.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/5t111111/priha.