https://github.com/natescherer/changelog-management-action
A GitHub action to parse and update changelogs in Keep a Changelog 1.0.0 format; built on the ChangelogManagement PowerShell module.
https://github.com/natescherer/changelog-management-action
Last synced: 4 months ago
JSON representation
A GitHub action to parse and update changelogs in Keep a Changelog 1.0.0 format; built on the ChangelogManagement PowerShell module.
- Host: GitHub
- URL: https://github.com/natescherer/changelog-management-action
- Owner: natescherer
- License: mit
- Created: 2021-04-15T17:20:30.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T02:59:47.000Z (5 months ago)
- Last Synced: 2024-11-11T09:17:37.869Z (5 months ago)
- Language: PowerShell
- Homepage:
- Size: 74.2 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- jimsghstars - natescherer/changelog-management-action - A GitHub action to parse and update changelogs in Keep a Changelog 1.0.0 format; built on the ChangelogManagement PowerShell module. (PowerShell)
README
# Changelog Management GitHub Action
[](https://natescherer.github.io/changelog-management-action/testreports/Windows/Windows.html)
[](https://natescherer.github.io/changelog-management-action/testreports/Linux/Linux.html)
[](https://natescherer.github.io/changelog-management-action/testreports/macOS/macOS.html)
[](#contributors-)
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
```yaml
steps:
- name: Update Changelog for Release
uses: natescherer/changelog-management-action@v1
with:
mode: release
releaseVersion: 2.0.0
```
### Read Changelog Data
```yaml
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
```yaml
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
This project follows the [all-contributors](https://allcontributors.org) specification.
Contributions of any kind are welcome!
## License
This project is licensed under The MIT License - see [LICENSE](LICENSE) for details.
