Download
Changelog CI is a GitHub Action that enables a project to automatically generate changelogs. Changelog CI can be triggered on pull_request, workflow_dispatch, and any other events that can provide the required inputs. Changelog CI uses python and GitHub API to generate a changelog for a repository. First, it tries to get the latest release from the repository (If available). Then, it checks all the pull requests/commits merged after the last release using the GitHub API. After that, it parses the data and generates the changelog. It is able to use Markdown or reStructuredText to generate a Changelog. Finally, It writes the generated changelog at the beginning of the CHANGELOG.md/CHANGELOG.rst (or user-provided filename) file. In addition to that, if a user provides a configuration file (JSON/YAML), Changelog CI parses the user-provided configuration file and renders the changelog according to user's configuration.
Features
- Workflow input options
- Use an optional configuration file
- The code in this project is released under the MIT License
- Changelog CI can be triggered on pull_request, workflow_dispatch and any other events
- GitHub Action that enables a project to automatically generate changelogs
- Generate changelog using Pull Request Title or Commit Messages made after the last release
Project Samples
