bfjira (branch from Jira) is a command-line utility that simplifies the process of creating Git branches based on JIRA ticket information. It ensures that branch names are consistent and informative by incorporating the issue type and summary from the JIRA ticket.
The recommended way to install bfjira is via pip from PyPI:
pip install bfjiraMake sure you have pip installed and are using a virtual environment if necessary.
To use bfjira, you must have the following environment variables set:
JIRA_SERVER: Your JIRA server URL.JIRA_EMAIL: The email address associated with your JIRA account.JIRA_API_TOKEN: Your JIRA API token.
Instructions for creating a Jira API token can be found here
Optionally, you can set the JIRA_TICKET_PREFIX environment variable to use a default prefix other than "SRE" for ticket IDs that are entered without a prefix.
-
Show help message:
bfjira --help
-
Create a branch for a JIRA ticket:
bfjira --ticket SRE-1234
If you only have the ticket number, bfjira will use the default prefix ("SRE" or whatever is set in
JIRA_TICKET_PREFIX):bfjira -t 1234
-
Set a custom issue type for the branch:
bfjira -t 1234 --issue-type hotfix
-
Create a branch without setting the upstream:
bfjira -t 1234 --no-upstream
-
Increase output verbosity (useful for debugging):
bfjira -t 1234 -v
-
Optionally prevent transitioning the ticket to 'In Progress':
By default, the script transitions the specified JIRA ticket to 'In Progress'. If you wish to create a branch for the ticket without changing its status, use the
--no-progressflag. This is useful when you need to perform operations on the ticket without indicating that work has started.bfjira -t 1234 --no-progress
Contributions to bfjira are welcome! Please read the contributing guidelines before submitting pull requests.
bfjira is released under the GNU General Public License. See the LICENSE file for more details.