go-jira

go-jira uses Go's text/template library for output and editor input.

1. Customizing a command: Create a file at .jira.d/templates/<command_name> (e.g., .jira.d/templates/edit).
2. Exporting defaults: Run jira export-templates to write the hard-coded default templates to ~/.jira.d/templates/.
3. Debugging templates: Use the debug flag to see the JSON data available to a template: jira view GOJIRA-321 -t debug or jira list -t debug.

If a .jira.d/config.yml file is executable, go-jira will execute it and use its stdout as the configuration. This allows for dynamic overrides based on the $JIRA_OPERATION environment variable.

Example: Using a shell script to set a specific template when running the list command:

#!/bin/sh

echo "endpoint: https://jira.mycompany.com"
echo "editor: emacs -nw"

case $JIRA_OPERATION in
    list)
      echo "template: table";;
esac

The tests require a Jira service running in a Docker container. You must manually run the setup script to initialize the test instance. Note that the test instance uses a temporary license (approximately 8 hours), so you will need to re-run the setup script at least once daily.

./000setup.t

go-jira uses a hierarchical configuration system. It recursively searches parent directories for a .jira.d directory, starting from your current working directory and moving up to your home directory.

1. Command-specific config: It loads <command>.yml from .jira.d/ (e.g., jira list loads .jira.d/list.yml).
2. Global/Context config: It merges properties from config.yml found in those directories.
3. Precedence: Files closer to the current working directory take precedence over parent directories. Command-line options have the final precedence.

You can set context-aware projects by creating ./.jira.d/config.yml in a project workspace:

project: foo

Since go-jira uses the kingpin library, it supports automatic bash/zsh shell completion. To enable tab completion in bash, add the following line to your .bashrc or .profile (ensure the jira binary is already in your PATH):

eval "$(jira --completion-script-bash)"

You can install go-jira by either downloading pre-built binaries or building from the source code using Go.

Download

Download pre-built binaries from the official releases page.

Build from source

To build and install the official repository, ensure GO111MODULE=on is set in your environment, then run:

go get github.com/go-jira/jira/cmd/jira

After installation, the binary will be available in $GOPATH/bin/jira.

Due to GDPR restrictions, the --user parameter is being phased out in favor of the --login option.

Commands that previously required a username (such as watch, create, or assign) now expect an email address. When using these commands, use the --login flag instead of --user to ensure compatibility with modern Atlassian API requirements.

The integration tests are written using the osht bash testing framework. To run the tests, you must first ensure a Jira service is running via Docker by executing the setup script.

From the top level of the project, use make to build the local jira binary and prove to run the integration tests located in the _t directory.

When developing Atlassian plugins, use the following SDK commands to manage the plugin lifecycle and debugging:

• atlas-run: Installs the plugin into the product and starts it on localhost.
• atlas-debug: Installs the plugin and starts it on localhost, but also allows a debugger to attach at port 5005.
• atlas-cli: Opens a Maven command line window after running atlas-run or atlas-debug. Inside this window, you can use the pi command to reinstall the plugin into the running product instance.
• atlas-help: Prints descriptions for all available commands in the SDK.