https://github.com/lee-dohm/extract-release-notes
A GitHub Action to extract release notes from pull requests
https://github.com/lee-dohm/extract-release-notes
action extract pull-requests release-notes
Last synced: 11 months ago
JSON representation
A GitHub Action to extract release notes from pull requests
- Host: GitHub
- URL: https://github.com/lee-dohm/extract-release-notes
- Owner: lee-dohm
- License: mit
- Created: 2019-06-21T15:09:45.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-01-26T02:01:47.000Z (about 3 years ago)
- Last Synced: 2025-03-26T10:09:39.648Z (11 months ago)
- Topics: action, extract, pull-requests, release-notes
- Language: TypeScript
- Homepage:
- Size: 597 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 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](https://spec.commonmark.org/0.29/#atx-headings) 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:
```markdown
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:
```yaml
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](LICENSE.md)