GitHub Action "New-ReleaseNotesFromChangeLog"

This action create ReleaseNotes.md file from ChangeLog.md content for specified project version (or for latest (top) version in ChangeLog.md).

Usage

See action.yml

Basic:

steps:
- uses: actions/checkout@v3
- uses: actions/New-ReleaseNotesFromChangeLog@v1
  with:
    release-notes-path: "RELEASENOTES.md" # path for generated file
    version: "v1.2.0" # project version for ReleaseNotes.md
    verbose: true # generate verbose action output

Automatic version project detection with GitVersion:

steps:
- uses: actions/checkout@v3
- uses: actions/New-ReleaseNotesFromChangeLog@v1
  with:
    use-gitversion: true
    gitversion-use-config-file: true
    release-notes-path: "RELEASENOTES.md"
    verbose: true

Use project version from tag name:

steps:
- uses: actions/checkout@v3
- uses: actions/New-ReleaseNotesFromChangeLog@v1
  with:
    use-tag-as-version: true
    release-notes-path: "RELEASENOTES.md"
    verbose: true

License

The scripts and documentation in this project are released under the MIT License.

Contributions

Contributions are welcome! See Contributor's Guide.