Skip to content

Latest commit

 

History

History
61 lines (45 loc) · 2.3 KB

README.md

File metadata and controls

61 lines (45 loc) · 2.3 KB
Raw

build-test

Jira Release/Archive Action

This Github action connects your CI and your Jira instance by creating release(Fix Version) and assign Jira issues to the release as part of your CI process.

  • Create a JIRA release, release date supports timezone overwrite.
  • Assign JIRA Issues to release
  • Achive a JIRA release

Usage

Example workflow:

jobs:
  release-fix-version:
    name: Release Jira Fix Version
    runs-on: ubuntu-latest
    steps:
      uses: justin-jhg/jira-release-actions@v1
      with:
        jira_base_url: ${{ secrets.JIRA_BASE_URL }}
        jira_user_email: ${{ secrets.JIRA_USER_EMAIL }}
        jira_api_token: ${{ secrets.JIRA_API_TOKEN }}
        jira_project: CI
        release_name: v9.0.2
        tickets: CI-123,CI-456
        release: true
        archive: false
        time_zone: Australia/Melbourne

Action Spec:

Inputs

Name Description Required? Type
jira_base_url URL of Jira instance. Example: https://<yourdomain>.atlassian.net Yes String
jira_api_token Access Token for Authorization. Example: HXe8DGg1iJd2AopzyxkFB7F2 (How To) Yes String
jira_user_email email of the user for which Access Token was created for . Example: [email protected] Yes String
jira_project Key of the jira project Yes String
release_name Name of the release (Fix Version) Yes String
time_zone timezone for release date to be set, e.g. Australia/Melbourne, default is UTC time No String
release Mark Jira fix version as released. Defaults to false. No Boolean
archive Mark Jira fix version as archived. Defaults to false. No Boolean
tickets Comma-separated list of Jira Issue Keys to include in the release. Defaults to ''. No String

Reference