:_content-type: REFERENCE

[id="alternative-methods-to-specify-tickets_{context}"]
= 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:

. The `-` character to start a list item.

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

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

** `Jira`
** `Bugzilla`
** `BZ` as a shorthand for `Bugzilla`

. 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.

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

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


.Tickets listed individually, using their IDs or keys
====

.Jira tickets
[source,yaml]
----
- [Jira, key: PROJECTA-123456]
- [Jira, key: PROJECTB-234567]
- [Jira, key: PROJECTC-345678]
----

.Bugzilla tickets
[source,yaml]
----
- [BZ, key: 1234567]
- [BZ, key: 2345678]
----

====

.Queries that result in multiple tickets
====

.A Bugzilla query copied from the URL of a Bugzilla search
[source,yaml]
----
- [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
[source,yaml]
----
- [BZ, search: '"f1=blocked&o1=equals&v1=12345678"']
----

.A standard JQL query
[source,yaml]
----
- [Jira, search: 'project="CentOS Stream" AND priority=Blocker']
----

.A saved Jira issue filter identified using JQL
[source,yaml]
----
- [Jira, search: 'filter = 12345678']
----

.All Jira tickets that are attached to an epic as its children
[source,yaml]
----
- [Jira, search: 'issue in childIssuesOf("PROJECT-123456")']
----

.All Jira tickets that are linked from a particular ticket, such as blocking or duplicating it
[source,yaml]
----
- [Jira, search: 'issue in linkedIssues("PROJECT-123456")']
----

====

.Overrides
====

.Overriding the subsystem value of a ticket
[source,yaml]
----
- [BZ, key: 1234567, { overrides: {subsystems: [sst_different]} }]
----

.Overriding the doc type value of a whole search
[source,yaml]
----
- [Jira, search: 'project="CentOS Stream" AND priority=Blocker', { overrides: {doc_type: "Known Issue"} }]
----

====

.References
====

[source,yaml]
----
- [BZ, key: 1234567, { references: [[BZ, key: 2345678], [Jira, key: PROJECTC-345678]] }]
----

====


[role="_additional-resources"]
.Additional resources
* For an explanation of the `overrides` keyword, see xref:organizing-a-ticket-manually_organizing-tickets-in-your-project-using-templates[].
* For an explanation of the `references` keyword, see xref:referring-to-another-ticket-from-a-release-note_organizing-tickets-in-your-project-using-templates[].
