gh-automator

1.0.3 • Public • Published

GH Automator

NPM version NPM downloads Build Status GitHub Issues GitHub Forks GitHub Stars

A Node GH plugin for automating git processes.

Maintained by Dustin Ryerson.

Install

[sudo] npm install -g gh gh-automator

Usage

gh automator

Alias: gh at

1. Cherry-pick fix

Option Usage Type Description
-c, --cherrypickfix Required Boolean Command to run
-r, --regex Required String Regex to use for cherry-pick
-b, --sourcebranch Required String Git branch the commits are being cherry-picked from
-s, --startinghash Optional String Hash to start cherry-picking from
-i, --uniqueissues Optional Boolean List possible dependencies for failed cherry-pick
-S, --submit Optional Boolean Submit a pull request upon successful cherry-pick
-u, --user Optional String Specify which user you are sending the pull request to
-p, --prbranch Optional String Specify which branch you are sending the pull request to

Examples

  • Attempts to cherry-pick commits where the commit message contains a regular expression (ie "LPS-12345") specified by the --regex option, from the branch specified by the --sourcebranch option, to the current branch. In the event of a failed cherry-pick the --startinghash and --uniqueissues options can be used.

gh automator --cherrypickfix --regex LPS-12345 --sourcebranch master * Shorthand version: gh at -c -r LPS-12345 -b master ```

  • Attempts to cherry-pick commits for LPS-12345 from the specified branch to the current branch and sends a pull request to githubUsername's ee-6.2.x branch if successful.

gh automator --cherrypickfix --regex LPS-12345 --sourcebranch master --submit --user githubUsername --prbranch ee-6.2.x * Shorthand version: gh at -c -r LPS-12345 -b master -S -u githubUserName -p ee-6.2.x ```

2. Print commit messages

Option Usage Type Description
-m, --printcommitmessage Required Boolean Command to run
-r, --regex Required String Regex to use for printing commit messages
-b, --sourcebranch Optional String Git branch the commit messages are being printed from

Examples

  • Prints all commit messages on the current branch containing the regular expression specified. A different branch can be specified by the --sourcebranch option.

gh automator --printcommitmessage --regex LPS-12345 * Shorthand version: gh at -m -r LPS-12345 ```

Testing

Check Travis for continous integration results.

  • Run JSHint, a tool to detect errors and potential problems.

npm run-script lint ```

  • Run Mocha, a unit test framework.

npm run-script test ```

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

  • v1.0.3 January 4, 2016

    • Update README
  • v1.0.2 December 23, 2015

    • Update README
  • v1.0.1 August 14, 2015

  • v1.0.0 August 14, 2015

    • Cherry-pick and Print Commit Message feature completion
  • v0.0.1 July 24, 2015

License

BSD License

Package Sidebar

Install

npm i gh-automator

Weekly Downloads

4

Version

1.0.3

License

BSD

Last publish

Collaborators

  • dustinryerson
  • bryanengler