Allows you to quickly select and prepend JIRA issues to git commit messages
Project description
Jira Issue Selector
A little utility for automatically selecting and prepending JIRA Cloud Issue keys to git commit messages.
Install:
Just run: pip3 install JiraIssueSelector
(or download and use one of the releases from the GitHub repo)
NB: This program requires Python 3.0 or later.
Configuration:
The Issue Selector needs to be configured globally, once; and then again one time for every project.
-
To configure it globally type:
git jira config global
-
To configure it locally type (while in a git repository):
git jira config local
If these files are not found by default, the program will automatically generate them and prompt you to edit them. This only happens on first-run. The Global configuration is applied every time the program is run, whereas the Local configuration is specific to the git repo and branch you're currently in.
The program stores all configuration and cache files in $HOME/.config/jira_issue_selector
. Cache files are updated every time the user invokes the script with the -u
flag, updates a configuration file, or the time specified in the Refresh Interval
field from a configuration file has passed since the program was last run.
NB: Configuration files are loaded in the following order: Global -> Local -> Additional config specified by the user
Usage:
Git Wrapper
usage: git jira [config global|local] [help] [commit]
optional arguments:
[commit] Run the issue-selector, then pass the selected issue to 'git commit'
[config] same as the -e flag below
[help] same as the -h flag below
Original Python Function
usage: python -m jira_issue_selector [-h] [-n num_results_to_show] [-c path_to_config_file] [-u]
[-e] [-d] [-nc] [-i issue_file_to_write_to]
A JIRA issue selector for git messages
positional arguments:
issue_file_to_write_to
The selected issue will be written to this file, if
passed. Use this to actually receive the output of the
program. I recommend using mktemp to generate this
file path.
optional arguments:
-h, --help show this help message and exit
-n num_results_to_show, --num-results num_results_to_show
The number of results to show on screen (default: 5)
-c path_to_config_file, --config-path path_to_config_file
The relative path to the configuration file. (default:
$HOME/.config/jira_issue_appender/jira.conf)
-u, --update-cache Update the issue cache. This happens automatically
according to the config (usually), but can be manually
controlled from here. (default: False)
-e, --edit-conf Drops the user into an editor to edit their
configuration file. The $EDITOR shell variable must be
set for this (default: False)
-d, --dry-run Does not save anything to the disk (cache or
otherwise) (default: False)
-nc, --no-cache Disables reading and writing to the cache (default:
False)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for JiraIssueSelector-1.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d1b8e50ab896c0a98e1690e5367f93a498a1e2db5b38462dfc41a4134899897 |
|
MD5 | 1cbe2fe8dc2488fe9573e45d91858de6 |
|
BLAKE2b-256 | d86ab579f1eaf26124ca8cfa5abb72de4db6a9ab7dbddbc00ec0d8308288d834 |