Skip to content

Commit 27a688e

Browse files
dellchclaude
andcommitted
docs: document Jira requirements field and Azure DevOps ticket support
- Document jira_requirements_field (instance-specific custom field id for acceptance criteria). - Add Azure DevOps to the supported git platforms for ticket context, now that Jira lookup is provider-agnostic. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 57f9923 commit 27a688e

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

docs/docs/core-abilities/fetching_ticket_context.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Fetching Ticket Context for PRs
22

3-
`Supported Git Platforms: GitHub, GitLab, Bitbucket`
3+
`Supported Git Platforms: GitHub, GitLab, Bitbucket, Azure DevOps`
44

55
!!! note "Branch-name issue linking: GitHub only (for now)"
66
Extracting issue links from the **branch name** (and the optional `branch_issue_regex` setting) is currently implemented for **GitHub only**. Support for GitLab, Bitbucket, and other platforms is planned for a later release. The GitHub flow was the most relevant to implement first; other providers will follow.
@@ -116,10 +116,22 @@ You can create an API token from your Atlassian account:
116116

117117
```toml
118118
[jira]
119+
jira_base_url = "https://<JIRA_ORG>.atlassian.net"
119120
jira_api_token = "YOUR_API_TOKEN"
120121
jira_api_email = "YOUR_EMAIL"
121122
```
122123

124+
#### Acceptance criteria / requirements (optional)
125+
126+
To include a ticket's acceptance criteria in the analysis, set `jira_requirements_field`
127+
to the id of the custom field that holds it. The field id is specific to your Jira
128+
instance (for example `customfield_10127`); leave it empty to skip requirements.
129+
130+
```toml
131+
[jira]
132+
jira_requirements_field = "customfield_10127"
133+
```
134+
123135
### Jira Data Center/Server
124136

125137
#### Using Basic Authentication for Jira Data Center/Server

0 commit comments

Comments
 (0)