1.8 KiB

Raw Blame History

JIRA auto-worklog

This plugin automatically logs time to Atlassian's JIRA bug tracking software when on a git branch with a JIRA issue ID in the branch name.

Installation

Add the plugin to the list of plugins for Oh My Zsh to load (inside ~/.zshrc):

```sh
plugins=(
    # other plugins...
    jira-auto-worklog
)
```

Usage

Every time the command prompt is generated, the time spent on a JIRA branch is accumulated. Once the accumulated time exceeds a threshold, the time is logged in the background. By default, the time is logged every minute.

To prevent AFK time from being counted, no time is logged if there is no activity on a JIRA branch for a certain amount of time. By default the AFK threshold is 30m.

Setup

The URL for your JIRA instance is located in the following places, in order of precedence:

$JIRA_URL environment variable
./.jira-url file in the current directory
~/.jira-url file in your home directory

The PAT for your JIRA instance is located in the following places, in order of precedence:

./.jira-pat file in the current directory
~/.jira-pat file in your home directory

Run jira-auto-worklog-check in this directory to check if the plugin is correctly configured.

Variables

$JIRA_URL - Your JIRA instance's URL
$JIRA_AUTO_WORKLOG_AFK_THRESHOLD - The number of minutes of AFK time before no time is logged. Defaults to 30
$JIRA_AUTO_WORKLOG_COMMENT - The comment to add to the work log. Defaults to an empty string
$JIRA_AUTO_WORKLOG_PRECISION - The size of the chunks of time that are logged. Must be greater than zero. Defaults to 1. For example, JIRA_AUTO_WORKLOG_PRECISION=15 will log 15 minutes after being active for 15 minutes a JIRA branch.

1.8 KiB Raw Blame History