Standard Release Notes
A GitHub action to extract release notes for a specific version from changelog generated by standard-version. For changelogs based on Conventional Commits.
Usage
Inputs
-
changelog_path
- Optional
- Path of the changelog file (relative to root). Default is
./CHANGELOG.md
.
-
version
- Required
- Name of the version in the changelog. (e.g. v1.2.1-beta.3).
- You can also provide the tag using
${{ github.ref }}
, if the workflow trigger is on push of tags.
Outputs
-
release_notes
- The release notes for a version.
Example
# Get the release notes. Set a convenient 'id' for accessing later
uses: yashanand1910/[email protected]
id: get_release_notes
with:
changelog_path: ./CHANGELOG.md # Optional
version: ${{ github.ref }} # Required
...
# An example of how to access the output
body: ${{ steps.get_release_notes.outputs.release_notes }}