Guides
Connect Jira
Let a labelled Jira issue become a plan and a pull request in your product's repository.
After this guide, a Jira issue that gets the Issue implementer's label becomes a plan, the code and a pull request. The agents comment on the Jira issue to say so.
Who can do it:
- The Jira key: a workspace admin or owner for every product, or a person who may change the product's own keys and tools.
- The Jira project key and the webhook: a workspace admin or owner, or a person who may change everything in that product.
See Roles.
Before you start
You need:
- A Jira Cloud site, such as
https://acme.atlassian.net. - An Atlassian account that can comment on the issues of the Jira project, and an API token of that account. You make the token in your Atlassian account settings.
- The Issue implementer turned on for the product. See Choose what starts by itself.
Step 1: add the Jira key
The key is this JSON text. Put in your own values:
{
"site": "https://acme.atlassian.net",
"email": "you@acme.com",
"api_token": "YOUR_ATLASSIAN_API_TOKEN"
}
- Open Settings → Integrations.
- In the group Where requests come from, press Connect on the row Jira.
- Paste the JSON, with your values, into the field Site and token.
- Under Use it for, choose every product, or one product.
- Press Save and test.
Step 2: name the Jira project
- Open the product's settings: Settings → Products, then Settings on the product's row.
- Open Technical settings at the end of the page.
- Under Jira, type the key of your Jira project in Jira project key, such as
ACME. - Press Save in the bar at the bottom of the window.
Step 3: make the webhook
A webhook tells the agents at once when a Jira issue is created or changed.
- In the product's Technical settings, find Webhooks. It shows once the Jira project key is saved.
- Press Make the Jira webhook. The page shows a URL and a JQL line.
- In Jira, open Settings → System → WebHooks → Create a WebHook.
- Paste the URL and the JQL. Tick "Issue: created" and "updated". Save the webhook in Jira.
The URL holds a secret. The page shows it once. If you lose it, press Make the Jira webhook again. A new secret replaces the old one, so paste the new URL into Jira too.
Step 4: give an issue the label
In Jira, add the Issue implementer's label to an issue. The label is agent:implement, unless you changed Label that starts it in the Issue implementer's options.
What you see when it worked
- A new suggestion appears under Suggestions, for the Jira issue. The agents start the plan and the code at once, because the label is your yes. Nothing goes on your product until the pull request is merged.
- The agents comment on the Jira issue when they start, and again with the pull request.
- The webhook shows set in the product's settings.
More
- Integrations: every integration and where its key can be.
- Approve a suggestion: what to do with the pull request.
- When something does not work.