cakeinpanic/jira-description
Add JIRA issue details to your GitHub pull request.
View on GitHubTrust Signals
- Scorecard Score
- Scorecard 4–6scored Jul 6, 2026
- Maintenance Recency
- Stalelast commit Oct 28, 2024
- License
- MIT
Pinned Snippet
uses: cakeinpanic/jira-description-action@235b8296c8b4f88c564297246810f084f853dac1 # v.10.0.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| github-token | Token used to update PR description and add labels. Can be passed in using {{ secrets.GITHUB_TOKEN }} | yes | — |
| jira-token | API Token used to access the JIRA REST API. Must have read access to your JIRA Projects & Issues. Format: <jira username>:<jira token> | yes | — |
| jira-base-url | The subdomain of JIRA cloud that you use to access it. Ex: "https://your-domain.atlassian.net" | yes | — |
| use | Where to look for issue key: branch | pr-title | both | no | — |
| skip-branches | A regex to ignore running on certain branches, like production etc. | no | "" |
| jira-project-key | Key of project in jira. First part of issue key | no | "" |
| custom-issue-number-regexp | Custom regexp to extract issue number from branch name. | no | "" |
| fail-when-jira-issue-not-found | Mark the PR status check as failed when a jira issue is not found | no | false |
Outputs
| name | description |
|---|---|
| jira-issue-key | The JIRA issue key. If key is not found the value is an empty string |
| jira-issue-found | Indication whether a jira issue was found or not |
| jira-issue-source | Indication how the jira issue was found, by - branch | pr-title | null |