https://github.com/frieder/jira-issue-info
A Github action to pull properties from a Jira issue and make it available to other steps via output
https://github.com/frieder/jira-issue-info
Last synced: 5 months ago
JSON representation
A Github action to pull properties from a Jira issue and make it available to other steps via output
- Host: GitHub
- URL: https://github.com/frieder/jira-issue-info
- Owner: frieder
- License: mit
- Created: 2023-03-03T21:18:59.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T13:52:21.000Z (6 months ago)
- Last Synced: 2024-11-19T14:52:37.352Z (6 months ago)
- Language: TypeScript
- Size: 439 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jira Issue Info - Github Action
[](https://github.com/frieder/jira-issue-info/actions/workflows/pr.yml)
[](https://github.com/frieder/jira-issue-info/issues?q=is%3Aopen+is%3Aissue)
[](https://sonarcloud.io/project/overview?id=frieder_jira-issue-info)
[](https://snyk.io/test/github/frieder/jira-issue-info)
A GitHub action to update properties of an existing Jira issue.
> - Only supports Jira Cloud.
> - Requires [Jira Login Action](https://github.com/marketplace/actions/atlassian-jira-login).
## Usage
```yaml
name: Get Jira Issue Properties
on: [..]
jobs:
jira-issue-info:
name: Jira Issue Info
runs-on: ubuntu-latest
steps:
- name: Jira Login
uses: frieder/gha-jira-login@v1
env:
JIRA_BASE_URL: ${{ vars.JIRA_BASE_URL }}
JIRA_USER_EMAIL: ${{ vars.JIRA_USER_EMAIL }}
JIRA_API_TOKEN: ${{ secrets.JIRA_API_TOKEN }}
- name: Get Issue Properties
id: issue
uses: frieder/jira-issue-info@v1
with:
retries: 1 # optional
retryDelay: 10 # optional
timeout: 2000 # optional
issue: WEB-123
customFields: |
previousStatus: 10858
transitionStatus: 10859
- name: Print Output
run: |
echo "Issue = ${{ steps.issue.outputs.issue }}"
echo "Summary = ${{ steps.issue.outputs.summary }}"
echo "Description = ${{ steps.issue.outputs.description }}"
echo "Type = ${{ steps.issue.outputs.type }}"
echo "Type ID = ${{ steps.issue.outputs.typeID }}"
echo "Status = ${{ steps.issue.outputs.status }}"
echo "Status ID = ${{ steps.issue.outputs.statusID }}"
echo "Priority = ${{ steps.issue.outputs.priority }}"
echo "Priority ID = ${{ steps.issue.outputs.priorityID }}"
echo "Labels = ${{ steps.issue.outputs.labels }}"
echo "Reporter Name = ${{ steps.issue.outputs.reporter }}"
echo "Reporter ID = ${{ steps.issue.outputs.reporterID }}"
echo "Assignee Name = ${{ steps.issue.outputs.assignee }}"
echo "Assignee ID = ${{ steps.issue.outputs.assigneeID }}"
echo "Components = ${{ steps.issue.outputs.components }}"
echo "Previous Status = ${{ steps.issue.outputs.previousStatus }}"
echo "Transition Status = ${{ steps.issue.outputs.transitionStatus }}"
echo 'JSON = ${{ steps.issue.outputs.json }}'
- name: Issue status is "To Do"
if: steps.issue.outputs.status == 'To Do'
run: echo "Ticket is in 'To Do'"
- name: Issue status is "In Progress"
if: steps.issue.outputs.status == 'In Progress'
run: echo "Ticket is 'In Progress'"
```
## Configuration Options
### Option: retries
| | |
| :------- | :-- |
| Required | no |
| Default | 1 |
This option allows to define a number of retries when the HTTP call to the Jira REST API fails (e.g. due to
connectivity issues). By default, the action will attempt one retry and after that report the action as failed.
### Option: retryDelay
| | |
| :------- | :-- |
| Required | no |
| Default | 10 |
In case the `retries` option is > 0, this option defines the time (in seconds) that the action will wait
before it sends another request.
### Option: timeout
| | |
| :------- | :--- |
| Required | no |
| Default | 2000 |
The time (in milliseconds) the action will wait for a request to finish. If the request does not finish in
time it will be considered failed.
### Option: issue
| | |
| :------- | :-- |
| Required | yes |
| Default | |
The ID of the Jira ticket (e.g. XYZ-123).
### Option: customFields
| | |
| :------- |:---|
| Required | no |
| Default | |
A multiline string of custom fields that defines which values should be made available as output.
The format is `: `. The field ID defines the number of the custom field
in Jira. The output name is the name used to register the custom field's value as output.
# Response Output
The action will provide the following outputs:
- `issue`: The issue key (e.g. XYZ-123).
- `summary`: The summary of the issue.
- `description`: The description of the issue.
- `type`: The type of the issue.
- `typeID`: The ID of the type of the issue.
- `status`: The status of the issue.
- `statusID`: The ID of the status of the issue.
- `priority`: The priority of the issue.
- `priorityID`: The ID of the priority of the issue.
- `labels`: The labels of the issue.
- `reporter`: The name of the reporter of the issue.
- `reporterID`: The ID of the reporter of the issue.
- `assignee`: The name of the assignee of the issue.
- `assigneeID`: The ID of the assignee of the issue.
- `components`: The components of the issue.
- `json`: The JSON response of the Jira REST API.
## Test Action
This action can be tested during development with the use of https://github.com/nektos/act.
Please adapt the values accordingly, both in the workflow file and in the CLI command.
```
act -W .github/workflows/pr.yml \
-j check \
-s JIRA_URL=*** \
-s JIRA_EMAIL=*** \
-s JIRA_TOKEN=***
```