alfred-gojira

module
v0.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 20, 2022 License: MIT

README

Alfred Gojira

Navigate your Jira issues in Alfred.

ScreenShot

Usage

  • Launch the workflow to view a list of issues obtained according to your configured query
  • Start typing input to filter the list
  • Press enter to open the url of the highlighted issue in your default browser
  • Press command + c to copy the key of the highlighted issue
  • Type workflow:config (with the workflow open) to enter configuration options

Configuration

This workflow provides an external trigger so that it can be launched from a hotkey of your choice without needing to alter the workflow itself. To set this up, in a workflow of your own, create a hotkey trigger or keyword input, and connect it to an external trigger output to Workflow ID com.pghk.gojira and Trigger ID issues.

When launched for the first time, a list of configuration options will appear. On subsequent launches this can be re-visited via a query of workflow:config. You can also edit these options from Alfred's workflow config UI.

Options

Hostname: the base URL of your Jira host, i.e. jira.atlassian.com

If your Jira host is public (as in the above example), set the Private Host variable to false or 0, and you'll be able to proceed to the main workflow without any further setup.

Username: this should be your email.

Projects: comma-separated list of Jira project keys (i.e. AB,XY,PROJ). These will be used to provide fallback issue suggestions, or scope fallback searches.

API Token: in order to authenticate to a private Jira host, you must create an API token and allow this workflow to use it. This will not be stored in the workflows settings; the workflow expects to find it your macOS keychain (under an "account" value equal to what you provided in the Hostname variable, and com.pghk.gojira as "name" and "where"). You can place your token in the Keychain Access application yourself, and grant access once Alfred requests it, or you can provide your token to the configuration option to have it placed in the keychain for you.

Max results: the total number of issues matching your query to request from the Jira API. Whatever you set here, issues will be loaded in the background in pages of 100 at a time, and held in the workflow's cache for 3 hours.

Query

To customize the scope of issues listed, modify the script value of this workflow's "gojira" script filter with your own custom query:

/list $1 -query "your JQL here"

The default query is simply for open issues: resolution = unresolved ORDER BY updated ASC.

Roadmap

  1. Move the query configuration to a variable, or
    1. as input from an external trigger, allowing users to configure multiple queries via different triggers

Big thanks 🙏🏼

Directories

Path Synopsis
cmd
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL