stackatdocs

.stackat.yml / option

jira

On this page

Adds a Create a Jira ticket from this issue link to every issue Stackat writes. No Jira credentials, no Jira app: Stackat never talks to Jira.

What it does#

Each new issue in the repository ends with the link. Clicking it opens your own Jira's create screen, with the summary, a short description and a link back to the GitHub issue filled in. You are signed in to Jira as yourself: check it, assign it to anyone and press Create.

  • Jira Cloud only (*.atlassian.net).
  • The link goes through app.stackat.dev, signed for that repository and issue, so it cannot be pointed anywhere else.
  • The ticket gets the label stackat, plus your labels.
  • Issues are written once: issues that already exist get the link only when rewritten with /stackpaw reevaluate.

Type and values#

KeyTypeAllowedRequired
jira.siteTextYour Jira Cloud address, such as acme.atlassian.net (https:// is fine)Yes
jira.project_idNumberThe project's number, not its key (10042, not PLAT)Yes
jira.issue_type_idNumberThe issue type's number (Task, Story, Bug …)Yes
jira.labelsList of textUp to 10; spaces become hyphensNo

Default: not set, no link.

Finding the numbers#

Jira Cloud's create screen wants numbers, not keys. Signed in to Jira, open this address in your browser, with your site and project key:

https://acme.atlassian.net/rest/api/3/project/PLAT

"id" is the project number, and "issueTypes" lists each type with its "id". You can also find the project number in Jira under Project settings → Details, in the address (pid=10042).

Organisation and repository#

The repository's jira replaces the organisation's as a whole. Set it once in the organisation's file when every team uses one project.

Problems you may see#

.stackat.yml: jira: site must be your Jira Cloud address, such as acme.atlassian.net
.stackat.yml: jira: project_id must be the number Jira shows for it (see README: Jira)
.stackat.yml: jira: issue_type_id must be the number Jira shows for it (see README: Jira)
.stackat.yml: jira: expected site, project_id and issue_type_id

Any of these means that file's jira is ignored (a repository then keeps the organisation's, if it has one); the rest of the settings apply. The dashboard's Settings tab shows the Jira site and project it read.

Examples#

One project for the whole organisation#

.github/.stackat.yml (organisation)yaml
jira:
  site: acme.atlassian.net
  project_id: 10042
  issue_type_id: 10001

A team's own project, with labels#

.stackat.ymlyaml
jira:
  site: https://acme.atlassian.net
  project_id: 10107
  issue_type_id: 10004      # Story
  labels: [platform, upgrades]