Skip to content
book-open

GitHub Action

[Jira] Release Notes Markdown

0.7 Latest version

[Jira] Release Notes Markdown

book-open

[Jira] Release Notes Markdown

This action generate release notes markdown from Jira project by version

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: [Jira] Release Notes Markdown

              
  uses: PRNDcompany/[email protected]
Learn more about this action in PRNDcompany/jira-release-notes

Choose a version

Jira Release Notes

This action generate release notes markdown from Jira project by version

# Release notes - Android - Version Customer 1.1.0

### Bug
[HDA-1234](https://your-domain.atlassian.net/browse/HDA-1234) XXXXXXX

### Epic
[HDA-1235](https://your-domain.atlassian.net/browse/HDA-1235) XXXXXXX

### Improvement
[HDA-2345](https://your-domain.atlassian.net/browse/HDA-2345) XXXXXXX
[HDA-2346](https://your-domain.atlassian.net/browse/HDA-2346) XXXXXXX

### Task
[HDA-7777](https://your-domain.atlassian.net/browse/HDA-7777) XXXXXXX
[HDA-7780](https://your-domain.atlassian.net/browse/HDA-7780) XXXXXXX
[HDA-7790](https://your-domain.atlassian.net/browse/HDA-7790) XXXXXXX

Inputs

  • domain: domain name. ex) https://your-domain.atlassian.net.
  • project: project id.
  • version: version name. ex) Customer 1.1.0
  • auth-token: auth token key.(Not Api key)

Auth Token

https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/

  1. Generate an API token for Jira using your Atlassian Account.
  2. Build a string of the form useremail:api_token. ([email protected]:xxxxxxx)
  3. BASE64 encode the string.
  • Linux/Unix/MacOS:
echo -n [email protected]:api_token_string | base64
  • Windows 7 and later, using Microsoft Powershell:
$Text = ‘[email protected]:api_token_string’
$Bytes = [System.Text.Encoding]::UTF8.GetBytes($Text)
$EncodedText = [Convert]::ToBase64String($Bytes)
$EncodedText

Outputs

  • release_note: Release notes (Markdown format)
  • release_notes_url: Release notes URL(Jira version url)

Example usage

name: Jira Release Notes
on:
  push:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Extract version name
      run: echo "version=$(echo '${{ github.event.head_commit.message }}' | egrep -o '[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}')" >> $GITHUB_OUTPUT
      id: extract_version_name           
    - name: Jira Release Notes
      id: release_notes
      uses: PRNDcompany/[email protected]
      with:
        domain: 'your-domain'
        project: 'HDA'
        version: Customer ${{ steps.extract_version_name.outputs.version }}
        auth-token: 'xxxxxxxx'
    - name: Print Release Notes
      run: |
        echo ${{ steps.release_notes.outputs.release_notes }}