emberist / mrburns

An amazing CLI tool boosting your speed in repetitive tasks

mrburns CLI

⚙️ Setup

Installation

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

Supported tools

Set the environment variables

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 GITLAB_TOKEN="PUT_YOUR_TOKEN_HERE"

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
• GITLAB_TOKEN

🚀 Run

Help

This command prints mrburns's help screen, which lists all the available commands and options.

mrburns --help

Start a task

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

Create a Merge Request

This commands packs a Gitlab Merge Request.

mrburns mr

Set your config file

This command helps you creating a mrburns.config.json file

mrburns config

The config file is something like this

{
  "create_draft_mr": true,
  ...
}

🧑‍💻 Develop

Run

cargo run -- <...commands>

Compile

cargo build

Test

cargo test

mrburns's Issues

Use native `Url` query params builder, instead of custom util

task-connectors > add github issues

slugify string is not replacing underscores (_)

Creating an mr using the `-t` option is not working

Remove "spinoff" dependency