jtuttle / workflow-tools

A CLI for managing issue workflow.

workflow-tools

A configurable CLI for managing project workflow.

Installation

1. Clone the repo:

   git clone [email protected]:jtuttle/workflow-tools.git
   cd workflow-tools

2. Install dependencies. Since workflow-tools is implemented in Ruby, you will first need to install RVM. Then:

   rvm install ruby-2.4.1
   gem install bundler
   bundle install

3. Copy config/config.yml.sample to config/config.yml and insert the credentials for your desired services:

   cp config/config.yml.sample config/config.yml

4. Add the /bin directory to your $PATH:

   echo "export PATH=\$PATH:<your>/<path>/<to>/workflow-tools/bin" >> ~/.profile

Commands

wf issues: list issues

wf status: shows the status of the issue for the current branch or given issue number

wf task_breakdown [issue_number]: posts a bulleted list of steps to the configured Slack channel

wf branch_name [issue_number]: prints a branch name for an issue

wf start [issue_number]: create a branch, perform an initial commit, and label the issue as "in progress"

wf code_review: create a pull request and (optionally) assign the issue to a reviewer

wf complete: merge pull request and (optionally) delete remote and local branches

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request