Skip to content

Command line tool to create git branches based off issue number and title

License

Notifications You must be signed in to change notification settings

rca/issuebranch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Issue branches

Create branches based off issue number and title

Setup

You'll need to set the following environment variables for the command to work.

YouTrack

YOUTRACK_PROJECT

The number for your YouTrack project, e.g. 0-0

YOUTRACK_API_URL

The URL to your project, for example, the hosted version would be https://<your_org>.myjetbrains.com/youtrack/api

YOUTRACK_TOKEN

Y our personal access token, e.g. perm:<stuff>.<more_stuff>.<even_more_stuff>

ISSUE_BACKEND

Can be set to youtrack, github, or redmine (specifically plan.io)

ISSUE_BACKEND_API_KEY

Your account's API key. On Github this is a Personal Access Token.

ISSUE_BACKEND_USER

For github, the user or organization the issue repository is under.

ISSUE_BACKEND_REPO

The organization or user's repo to find the issues.

The above environment variables will make a request similar to the following:

curl -H "Authorization token ${ISSUE_BACKEND_API_KEY}" https://api.github.com/repos/${ISSUE_BACKEND_USER}/${ISSUE_BACKEND_REPO}/issues/${issue_number}

changetype labels

Issue Example

The command expects to find a label prefixed with changetype: to create the branch. For example, some labels can be changetype:feature, changetype:bugfix, etc. This prefix will be used to namespace the branch.

Basic Usage

The example below issue 54 is labeled with changetype:feature and has the title Refactor endpoints:

[berto@g6]$ issue-branch 54

[berto@g6]$ git branch | grep '^*'
* feature/54-refactor-endpoints

Note: YouTrack issues would have letter prefixes. For example, issue 1931 in a project named "Super Project" would be something like sp-1931.

About

Command line tool to create git branches based off issue number and title

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •