Issue tracking
Jira
Create a Jira Cloud issue from a build or a screenshot, with the build link and the diff.
The Jira integration works like Linear: a Create issue button in the build review files an issue in the Jira project you chose, with the build link and the diff. It supports Jira Cloud.
| You get | Where |
|---|---|
| A Create issue button | The build review header, for the selected screenshot or the whole build |
The issue key (for example WEB-45) |
On the build, and in a Created WEB-45 toast |
Set up
Section titled “Set up”An owner or admin of the workspace opens Workspace settings › Integrations › Add integration › Jira.
- In Atlassian, create an API token at id.atlassian.com: Security › API tokens.
- In CirCI, enter the Site address (
acme.atlassian.net;https://is added when you leave it out), the Account email and the API token, and connect.
The site address must be an https address with a host name: IP addresses, localhost and .local names are refused, so the server can't be pointed at its own network. CirCI checks the credentials with Jira on connect. The token is stored encrypted. Issues are created as the account that owns the token. If Jira later rejects the credentials, the integration is flagged as needing attention.
Choose a project and issue type
Section titled “Choose a project and issue type”On the Jira integration's page, choose a Jira Project for each CirCI project. There's also an optional Issue type text field. Left empty, issues are created as Task. Whatever you type must exist in that Jira project. CirCI doesn't check it when you save, so a wrong name only fails when someone tries to create an issue, with Jira's error in the dialog. A project maps to one Jira connection at a time.
What appears where
Section titled “What appears where”The dialog and the description are the same as for Linear: a title pre-filled as Visual regression: <screenshot> in build #<number>, a description preview, and a Tracker switch when the project has both trackers. For Jira the dialog also shows the target Jira project key.
The description is sent as paragraphs, with the build address and a Diff: line holding the diff image address. The image is linked, not attached, because attaching needs the image bytes and those sit behind CirCI's sign-in. People open the link in a browser where they are signed in to CirCI.
On success CirCI records the issue key (for example WEB-45) on the build and shows a Created WEB-45 toast. On failure nothing is recorded.
Troubleshooting
Section titled “Troubleshooting”| What you see | Why, and what to do |
|---|---|
| The site address is refused | It must be an https address with a host name. IP addresses, localhost and .local names are refused |
| Connect fails with a message | Jira rejected the email and API token pair. Check the account email and create a new token |
| Creating an issue fails with Jira's error | The Issue type doesn't exist in that Jira project. CirCI doesn't check it when you save. Fix the name or leave it empty for Task |
| The integration shows needs attention | Jira rejected the credentials later. Connect again |
Not supported yet
Section titled “Not supported yet”- Status sync, transitions and comments back to Jira.
- Jira Server and Data Center. Only Jira Cloud sites are supported.
- Attaching the diff image to the issue.
- Choosing assignee, labels or priority in the dialog.
Not yet verified against Jira Cloud.