lee-dohm / extract-release-notes

A GitHub Action to extract release notes from pull requests

Extract Release Notes Action

A GitHub Action that extracts release notes from pull requests.

Use

Release notes are extracted from the body of the pull request. It looks for content starting after a Markdown header of Release notes, case insensitive and the trailing s is optional. Everything after that header is considered to be release notes content.

Please note: The space after the one to six # characters is required.

Example:

This is the body of a pull request. Describe everything necessary to do with the PR here.

## Release notes

- Fixed the thingamabob
- Tweaked the whoosywhatsis
- Added a foozle

If no release notes section is found, an error status is returned.

Inputs

• releaseNotesPath — Path to the file where you want the release notes stored when found (default: $GITHUB_WORKSPACE/__RELEASE_NOTES.md)

Outputs

• releaseNotesPath — Path where the release notes were stored if they were found

Example

Validate that a pull request contains a release notes section:

name: Validate release notes

on:
  pull_request:
    types: [opened, reopened, synchronized, edited]

jobs:
  validateReleaseNotes:
    name: Validate release notes
    runs-on: ubuntu-latest
    steps:
      - name: Extract release notes
        uses: lee-dohm/extract-release-notes@v2

License

MIT