Skip to content
Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Create release notes - Github action

A GitHub Action to extract jira tickets from commits and generate release notes.

Usage

  1. Create a .github/workflows/generate-notes.yml file in your GitHub repo.
  2. Add the following code to the generate-notes.yml file.
on:
pull_request:
types:
- opened
- synchronize
- reopened
- ready_for_reviewbranches:
- masterjobs:
attach:
runs-on: ubuntu-18.04steps:
- uses: actions/checkout@v2with:
fetch-depth: 0
- name: Generate branch diff fileif: success()run: | echo "Head branch: ${GITHUB_HEAD_REF}" echo "Base branch: ${GITHUB_BASE_REF}" git log origin/${GITHUB_BASE_REF}..origin/${GITHUB_HEAD_REF} > ./branch-diff.txt - name: Generate release notesif: success()uses: juztcode/create-release-notes@1.0.0with:
branch-diff-file: ./branch-diff.txtjira-project-key: TESTjira-url: "https://ustocktrade.atlassian.net/secure/CreateIssueDetails!init.jspa?pid=10907"

Inputs

InputPurpose
branch-diff-fileFile contains commit message difference between head and base branches.
jira-project-keyJira project key used to extract ticket ids from commit message (TEST key will detect all ticket ids with pattern TEST-).
previous-versionPrevious version released
new-versionNew version to be released
jira-urlJira url to use when generating create release ticket link.

Outputs

OutputPurpose
release-notesGenerated release notes.

About

Attach jira tickets

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages