Github repos | Gitlab repos | Bitbucket repos | |
---|---|---|---|
Github issues | ✅ | ✅ | 🚧 WIP |
Asana | ✅ | ✅ | 🚧 WIP |
Jira | ✅ | ✅ | 🚧 WIP |
First, install rustup and cargo, here the docs
then run this command
cargo install mrburns --git https://github.com/emberist/mrburns
or, clone this repo and add the required permission to the install.sh
script
chmod a+x ./install.sh
Then run the install.sh
script:
./install.sh
Based on which tool you are using, you have to add the following environment variables in your ~/.zshrc
file (or ~/.bashrc
if you use Bash).
export JIRA_USERNAME="PUT_YOUR_USERNAME_HERE"
export JIRA_TOKEN="PUT_YOUR_TOKEN_HERE"
export GITHUB_TOKEN="PUT_YOUR_TOKEN_HERE" # read-only token used to access your github issues
After that, do not forget to run source ~/.zshrc
(or source ~/.bashrc
if you use Bash). 🤓
Here are some hints on how to generate the tokens.
- JIRA_USERNAME: should be the email associated with your jira account
- JIRA_TOKEN
- GITHUB_TOKEN
This command prints mrburns's help screen, which lists all the available commands and options.
mrburns --help
This commands switches to a new Git branch to start working on it. mrburns takes care of creating a proper name for the branch starting from the task title.
mrburns start https://your-domain.atlassian.net/browse/foo-3293
NOTE: There is an options --type
option (or -t
) to choose the task type between bugfix, chore or feature
This commands open for you a prefilled marge reuest page
mrburns mr
Helpful when you need to quickly open you task from the codebase current branch!
mrburns browse
This command helps you creating a mrburns.config.json
file
mrburns config
The config file is something like this
{
"create_draft_mr": true,
...
}
cargo run -- <...commands>
cargo build
cargo test