https://github.com/purplebooth/changelog-action
https://github.com/purplebooth/changelog-action
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/purplebooth/changelog-action
- Owner: PurpleBooth
- License: cc0-1.0
- Created: 2021-10-16T14:05:34.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-27T18:03:15.000Z (over 3 years ago)
- Last Synced: 2024-06-13T00:22:55.640Z (about 2 years ago)
- Size: 20.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# changelog-action
A composite action that wraps the
[git-cliff](https://github.com/orhun/git-cliff)
[action](https://github.com/orhun/git-cliff-action) with a default
config
## Input variables
- `config`: Path of the configuration file. (Default: `"cliff.toml"`)
- `args`: [Arguments](https://github.com/orhun/git-cliff#usage) to pass
to git-cliff. (Default: `"-v"`)
- `output`: The output file to write to (Default: `"CHANGELOG.md"`)
## Output variables
- `changelog`: Output file that contains the generated changelog.
## Example usage
### Generate the changelog
``` yaml
generate-changelog:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
ref: v1.1.0
- uses: PurpleBooth/changelog-action@v0.3.3
with:
args: v1.0.0..v1.1.0
```