Render a graph view of blocking -> blocked relationships from JIRA epics.
This app consists of two components:
- a backend API server responsible for pulling data from Jira
- a frontend single page application that talks to the API server
When built, the backend API server binary, graphcmd, will embed all frontend assets. The app can be deployed as a single graphcmd binary.
Install NodeJS 16 or newer: https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-20-04
- Build the frontend first, so that the 'dist' folder can be embedded when the backend is compiled:
npm install
npm run build
- Build the backend:
go install github.com/andrei-m/jira-graph/graphcmd
- Start up the backend API server. Override any field mappings as needed (see instructions for how to discover your Jira instance's field keys below)
JIRA_USER=your_jira_username JIRA_PASS=your_jira_password $GOPATH/bin/graphcmd -jira-host=your.jira.host -estimate-field=your_customfield_id_override
JIRA_PASS can be a password or API token. 4. Start up the frontend in dev mode for quick iteration
npm run dev
Access the API server on port 8080 and the SPA on port 3000.
To discover field IDs for passing as flag values, your JIRA instance's issue fields can be found like:
curl https://subdomain.atlassian.net/rest/api/2/field --user <JIRA_USER>:<JIRA_PASS>
This section describes how to set up a sample Jira cloud instance for testing purposes.
- Sign up for a Jira account from https://www.atlassian.com/software/jira . Note the subdomain you use to sign up; in this example, it is
jiragraph. - Set up an API token https://id.atlassian.com/manage-profile/security/api-tokens
- Find the ID of the estimate field:
curl https://jiragraph.atlassian.net/rest/api/2/field --user <email you used to sign up>:<api key> | jq '.[] | select(.name=="Story Points") | .id'
- Create an epic and a couple of issues with 'Epic Link' set to the epic. Add blocking relationships between the issues. In this example, the epic key is
JG-1 - Use the instructions above to start up jiragraph. Pass the value from step 3 to
-estimate-field - If running the local Vite dev server, navigate to your epic key, e.g. http://localhost:3000/issues/JG-1