Generate the release notes from a milestone before creating a new release.
Create a workflow .yml file in your .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.
repository: Github repository. Add the Github context value: github.repository. (required)
milestone: Milestone id, not title please. (required)
custom-row: Custom row format. You're able to use the Github issue object values to build your row.
Example: "(#${issue.number}) - ${issue.title}: ${issue.body}"
custom-group-by-label: You're able to create groups by combining issue labels. You must add a collection of groups and each group hastitle and labels.
release-notes: Formatted release notes.
name: Generete release from milestone
on:
workflow_dispatch:
inputs:
milestone:
description: "Milestone ID"
required: true
version:
description: "Version to be released"
required: true
jobs:
generate-release:
name: Generete release from milestone
runs-on: ubuntu-latest
steps:
- name: Relese notes format
uses: Beakyn/gha-format-release-notes@v1
id: format
env:
GITHUB_TOKEN: ${{ github.token }}
with:
# required
repository: ${{ github.repository }}
milestone: ${{ github.event.inputs.milestone }}
# optional
custom-row: "${issue.number} <--> ${issue.title}"
custom-group-by-label: |
[
{
"title": "### Feature 🎉",
"labels": ["feature"]
},
{
"title": "### Bug Fixes 🐛",
"labels": ["bug"]
},
{
"title": "### Refactor & Improvements ✨",
"labels": ["enhancement", "refactor", "chore"]
}
]
- name: Create Release
id: create_release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ github.token }}
with:
tag_name: ${{ github.event.inputs.version }}
release_name: Release ${{ github.event.inputs.version }}
body: ${{steps.format.outputs.release-notes}}
draft: false
prerelease: false
- name: Close milestone
uses: Beakyn/gha-close-milestone@master
env:
GITHUB_TOKEN: ${{ github.token }}
with:
# required
repository: ${{ github.repository }}
milestone: ${{ github.event.inputs.milestone }}
Format Release Notes is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(1)Format Release Notes is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.