Jira reference#

Quick reference for Jira fields, statuses, and workflows at SKAO.

Key URLs#

Resource	URL
SKAO Jira	jira.skatelescope.org
GitLab-Jira integration	GitLab documentation
Release Management project	REL Jira project

Release management tickets#

REL tickets track a software release through version preparation, tag creation, publication, and release-note traceability. Use the ticket key in the release commit created by Pipeline Machinery. When the release pipeline succeeds, it can add the GitLab Release link and release-note information to the ticket.

See Create a release management ticket to create a REL ticket and Create a software release with Pipeline Machinery to make the release.

REL issue types and fields#

Choose an issue type according to the release scope:

Issue type	Use for
Component Version	Releasing one software component.
Sub-system Version	Releasing a sub-system.
System Version	Releasing a system-level product.

The REL create form requires a component, product, artefact version, and summary. It also provides ART, Agile Team, collaborator, and fix-version fields for release coordination. The description starts with a release-note template for added, changed, deprecated, removed, and fixed items.

Ticket types#

The issue types available depend on the project and team. The types most teams use are:

Type	Description
Epic	Large feature that spans multiple sprints
Story	User-facing functionality
Enabler	Technical work that supports future features (architecture, infrastructure, research, or compliance)
Task	Technical work item
Spike	Time-boxed research or investigation
Improvement	Enhancement to existing functionality
Bug	Defect requiring a fix
Document	Documentation work item

Workflow statuses#

Status	Description
Backlog	Raised but not yet scheduled for work
To Do	Scheduled but not started
In Progress	Actively being worked on
Reviewing	Under code review or testing
Ready for Acceptance	Awaiting Product Owner acceptance
Done	Completed and accepted
Blocked	Cannot proceed due to a dependency or issue
Discarded	Closed without being completed

GitLab integration keywords#

Use these keywords in commit messages or MR descriptions:

Keyword	Effect
`SKA-123`	Links the commit or MR to the Jira ticket
`Closes SKA-123`	Links, and marks the MR as closing the ticket. The status change is not automatic at SKAO — move the ticket manually.
`Fixes SKA-123`	Same as `Closes`
`Resolves SKA-123`	Same as `Closes`

Branch naming convention#

Include the Jira ticket ID in your branch name:

<jira-id>-<description>

Examples:

ska-123-add-login-feature
ska-456-fix-pipeline-timeout