Skip to content

Latest commit

 

History

History
123 lines (90 loc) · 3.25 KB

ref_alternative-methods-to-specify-tickets.adoc

File metadata and controls

123 lines (90 loc) · 3.25 KB

Alternative methods to specify tickets

The {bin-name}/tickets.yaml configuration file recognizes several kinds of syntax to identify tickets that belong into your release notes document.

The general structure of a ticket entry

Each entry in the {bin-name}/tickets.yaml configuration file follows this structure:

  1. The - character to start a list item.

  2. A pair of square brackets ([ ]) to contain the entry.

  3. A keyword that identifies the ticket tracker, followed by a comma. The following values are supported:

    • Jira

    • Bugzilla

    • BZ as a shorthand for Bugzilla

  4. A keyword that specifies the method to retrieve tickets. The following values are supported:

    • key to select a single ticket, followed by the ID or key of the ticket.

    • search to select all tickets that match a search, followed by a string in the format that the ticket tracker recognizes as a search query.

  5. Optional: The overrides keyword, which enables you to manually override the value of the ticket’s doc type, components, or subsystems.

  6. Optional: The references keyword, which enables you to attach multiple additional ticket IDs to this release note.

Example 1. Tickets listed individually, using their IDs or keys
Jira tickets
- [Jira, key: PROJECTA-123456]
- [Jira, key: PROJECTB-234567]
- [Jira, key: PROJECTC-345678]
Bugzilla tickets
- [BZ, key: 1234567]
- [BZ, key: 2345678]
Example 2. Queries that result in multiple tickets
A Bugzilla query copied from the URL of a Bugzilla search
- [BZ, search: 'bug_status=VERIFIED&bug_status=CLOSED&product=Our Container Platform&target_release=1.23.0']
All Bugzilla bugs that block a particular bug, sometimes called a tracker
- [BZ, search: '"f1=blocked&o1=equals&v1=12345678"']
A standard JQL query
- [Jira, search: 'project="CentOS Stream" AND priority=Blocker']
A saved Jira issue filter identified using JQL
- [Jira, search: 'filter = 12345678']
All Jira tickets that are attached to an epic as its children
- [Jira, search: 'issue in childIssuesOf("PROJECT-123456")']
All Jira tickets that are linked from a particular ticket, such as blocking or duplicating it
- [Jira, search: 'issue in linkedIssues("PROJECT-123456")']
Example 3. Overrides
Overriding the subsystem value of a ticket
- [BZ, key: 1234567, { overrides: {subsystems: [sst_different]} }]
Overriding the doc type value of a whole search
- [Jira, search: 'project="CentOS Stream" AND priority=Blocker', { overrides: {doc_type: "Known Issue"} }]
Example 4. References
- [BZ, key: 1234567, { references: [[BZ, key: 2345678], [Jira, key: PROJECTC-345678]] }]
Additional resources