A configurable CLI for managing project workflow.
-
Clone the repo:
git clone git@github.com:jtuttle/workflow-tools.git cd workflow-tools
-
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
-
Copy
config/config.yml.sample
toconfig/config.yml
and insert the credentials for your desired services:cp config/config.yml.sample config/config.yml
-
Add the
/bin
directory to your$PATH
:echo "export PATH=\$PATH:<your>/<path>/<to>/workflow-tools/bin" >> ~/.profile
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
- Fork it
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Added some feature')
- Push to the branch (git push origin my-new-feature)
- Create new Pull Request