This action will transition the list of Jira issues provided between states, or it will display the available transitions and the current issue state.
- uses: bitflight-devops/github-action-transition-jira-ticket@v1.1.0
with:
# A comma delimited list of one or more Jira issues to be transitioned
issues: ''
# YAML configuration that overrides the configuration in the
# `.github/github_event_jira_transitions.yml` file.
jira_transitions_yaml: ''
# The Jira cloud base url including protocol i.e. 'https://company.atlassian.net'
# or use environment variable JIRA_BASE_URL
jira_base_url: ''
# The Jira cloud user email address or use environment variable JIRA_USER_EMAIL
jira_user_email: ''
# The Jira cloud user api token or use environment variable JIRA_API_TOKEN
jira_api_token: ''
# If there is an error during transition, the action will error out.
# Default: false
fail_on_error: ''
Input | Description | Default | Required |
---|---|---|---|
issues |
A comma delimited list of one or more Jira issues to be transitioned | true | |
jira_transitions_yaml |
YAML configuration that overrides the configuration in the .github/github_event_jira_transitions.yml file. |
false | |
jira_base_url |
The Jira cloud base url including protocol i.e. 'https://company.atlassian.net' or use environment variable JIRA_BASE_URL | false | |
jira_user_email |
The Jira cloud user email address or use environment variable JIRA_USER_EMAIL | false | |
jira_api_token |
The Jira cloud user api token or use environment variable JIRA_API_TOKEN | false | |
fail_on_error |
If there is an error during transition, the action will error out. | false |
**Output** | **Description** | **Default** | **Required** |
---|---|---|---|
issueOutputs |
A JSON list of Jira Issues and their transition details | undefined | undefined |
The issueOutputs
JSON structure
[
{
"issue": "string",
"names": ["string", "array"],
"ids": ["string", "array"],
"status": "string",
"beforestatus": "string"
}
]