https://github.com/nuuday/github-changelog-action
Github Action for creating a CHANGELOG.md file based on semver and conventional commits.
https://github.com/nuuday/github-changelog-action
conventional-changelog conventional-commits docker github-actions
Last synced: 4 months ago
JSON representation
Github Action for creating a CHANGELOG.md file based on semver and conventional commits.
- Host: GitHub
- URL: https://github.com/nuuday/github-changelog-action
- Owner: nuuday
- License: mit
- Created: 2020-04-07T12:21:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T15:51:02.000Z (almost 3 years ago)
- Last Synced: 2025-09-01T17:03:09.457Z (4 months ago)
- Topics: conventional-changelog, conventional-commits, docker, github-actions
- Language: Shell
- Size: 17.6 KB
- Stars: 4
- Watchers: 1
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Generate changelog with git-chglog
Github Action for creating a CHANGELOG.md file based on semver and conventional commits.
## Usage
### Pre-requisites
Create a workflow .yml file in your repositories .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.
Further more you need to have [git-chlog](https://github.com/git-chglog/git-chglog) configured and have the configuration added to your git repository.
### Inputs
- `next_version`: Next version number
- `config_dir`: git-chglog configuration directory. Default: `.ghglog`
- `filename`: Filename to write the changelog to. Default: `CHANGELOG.md`
- `tag`: Optional, Generate changelog only for this tag.
### Outputs
- `changelog`: Changelog content if no `filename` input is empty
### Example workflow - upload a release asset
On every `push` to `master` generate a CHANGELOG.md file.
```yaml
name: Build and release
on:
push:
branches:
- master
pull_request:
branches:
- master
jobs:
package:
runs-on: ubuntu-latest
steps:
- uses: nuuday/github-changelog-action@v1.0.0
with:
next_version: "1.0.0"
```
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE)
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/nuuday/github-changelog-action/tags).
## Authors
* **Steffen F. Qvistgaard** - *Initial work* - [ssoerensen](https://github.com/ssoerensen)
See also the list of [contributors](https://github.com/nuuday/github-changelog-action/contributors) who participated in this project.