Changelog Management GitHub Action

A GitHub action to parse and update changelogs in Keep a Changelog 1.0.0 format; built on the ChangelogManagement PowerShell module.

Provides management tasks for changelogs, including updating for a release, reading data, and adding new changes.

It is tested and runs on windows-latest, ubuntu-latest, and macos-latest.

Usage

Release

    steps:
      - name: Update Changelog for Release
        uses: natescherer/changelog-management-action@v1
        with:
          mode: release
          releaseVersion: 2.0.0

Read Changelog Data

    steps:
      - name: Read Changelog Data
        id: readchangelog
        uses: natescherer/changelog-management-action@v1
      - name: Echo Changelog Data
        run: |
          echo "${{ steps.readchangelog.outputs.lastVersion }}"
          echo "${{ steps.readchangelog.outputs.releaseNotes }}"

Add New Change

    steps:
      - name: Add Change
        uses: natescherer/changelog-management-action@v1
        with:
          mode: addchange
          changeType: added
          changeValue: Quantum entanglement

Inputs

Name	Required	Default	Description
path	false	CHANGELOG.md	Path to relative to the root of the project to a CHANGELOG.md file in Keep a Changelog 1.0.0 format. Defaults to CHANGELOG.md in the root of the project.
mode	false	readdata	Mode for the action. Should be one of readdata, release, or addchange. Defaults to readdata.
releaseVersion	false		Version number to use when updating a changelog for release. Only valid for mode release.
changeType	false		Type of change to add. Should be one of Added, Changed, Deprecated, Removed, Fixed, or Security. Only valid for mode addchange.
changeValue	false		Data for the change to add. Should be a single line string. Only valid for mode addchange.

Outputs

Name	Description
lastVersion	The version number of the latest release in the changelog.
releaseNotes	Release notes composed of changes from the most recent release.

Contributors

Nate Scherer 💻 🚇 📖

This project follows the all-contributors specification. Contributions of any kind are welcome!

License

This project is licensed under The MIT License - see LICENSE for details.