https://github.com/patrickjahns/chlgr
📃 Github Action that creates a changelog and provides the content via pull requests to be merged for a future release
https://github.com/patrickjahns/chlgr
action changelog changelog-generator github-action github-changelog-generator
Last synced: 3 months ago
JSON representation
📃 Github Action that creates a changelog and provides the content via pull requests to be merged for a future release
- Host: GitHub
- URL: https://github.com/patrickjahns/chlgr
- Owner: patrickjahns
- License: mit
- Created: 2020-03-01T14:41:41.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T04:58:00.000Z (over 3 years ago)
- Last Synced: 2026-03-26T11:35:59.768Z (4 months ago)
- Topics: action, changelog, changelog-generator, github-action, github-changelog-generator
- Language: JavaScript
- Size: 1.72 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# chlgr
Creates a changelog and provides the content via pull requests to be merged for a release
## Introduction
This action provides the functionality of [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator) to easily and automatically manage a human readable changelog.
chlgr differentiates itself from other changelog actions, by managing the changelog in a separate branch and as well as maintaining and creating a pull request with the changelog.
The rationale behind here is, that released artifacts should contain a up-to-date changelog with the correct version set.
## Usage
```yaml
- uses: patrickjahns/chlgr@v1
with:
# A prefix to be used for the commit msg and pr title
# Default: [RELEASE]
commit-msg-prefix: ''
# The filename of the changelog
# Default: CHANGELOG.md
changelog-file: ''
# The base for the pull-request chlgr creates
# Default: master
base-branch: ''
# The branch used by chlgr for pushing the changelog and basing the pull request
# off towards `base-branch`
# Default: release/next
release-branch: ''
# If provided, this will be used as version for the changelog and the pull request
# title
# Default: unknown
release-version: ''
# If set, the action will not push the changelog or create a pull request
dry-run: ''
# Auth token used to push the changes back to github and create the pull request
# with. [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
# Default: ${{ github.token }}
token: ''
```
## Examples
### Basic example
```yaml
name: Update Changelog
on:
push:
branches:
- master
jobs:
changelog:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: update changelog
uses: patrickjahns/chlgr@v1
```
### Passing a version to the action
```yaml
name: Update Changelog
on:
push:
branches:
- master
jobs:
changelog:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: calculate next version
id: version
uses: patrickjahns/version-drafter-action@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: update changelog
uses: patrickjahns/chlgr@v1
with:
release-version: ${{ steps.version.outputs.next-version }}
```
## Extended configuration
This action utilizes [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator) therefor all [configuration options](https://github.com/github-changelog-generator/github-changelog-generator/wiki/Advanced-change-log-generation-examples)
are also applicable for this action by creating a [`.github_changelog_generator` params file](https://github.com/github-changelog-generator/github-changelog-generator#params-file).
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE)