Skip to content

Standard Release Notes

Actions
A GitHub action to extract release notes for a version from the changelog generated by standard-version
v1.5.0
Latest
Star (7)

Standard Release Notes release-please

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 and 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 }}

Standard 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.

About

A GitHub action to extract release notes for a version from the changelog generated by standard-version
v1.5.0
Latest

Standard 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.