What is Changelog CI?
Changelog CI is a GitHub Action that generates changelog, prepends it to CHANGELOG.md file and commits it to a release pull request
How Does It Works:
It uses a python script with GitHub API to get the last release. Then it checks all the pull request merged after the last release and writes it to CHANGELOG.md or user provided file. The pull request title must start with release *anything else for example: Release 0.1.1 releasing a new version The Changelog CI will see the pull request and submit a commit to the pull request with the changes written in the CHANGELOG.md file.
Based on the "RESTful API" category.
Alternatively, view Changelog CI alternatives based on common mentions on social networks and blogs.
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of Changelog CI or a related project?
Changelog CI Banner
GitHub release (latest by date) GitHub Workflow Status GitHub GitHub Marketplace GitHub stars
Changelog CI is a GitHub Action that generates changelog,
Then the changelog is prepended to CHANGELOG.md file and committed
and/or commented to the release Pull request.
Changelog CI uses python and GitHub API to generate changelog for a repository.
First, it tries to get the latest release from the repository (If available).
Then, it checks all the pull requests merged after the last release using the GitHub API.
After that, it parses the data and generates the changelog. Finally,
It writes the generated changelog at the beginning of the CHANGELOG.md (or user-provided filename) file.
In addition to that, if a user provides a config (JSON file), Changelog CI parses the user-provided config file
and renders the changelog according to users config.
Then the changes are committed and/or commented to the release Pull request.
To use this Action The pull request title must match with the default regex
or the user-provided regex from the config file.
Default Title Regex: ^(?i:release) (title must start with the word "release" (case insensitive))
Default Version Number Regex: This follows SemVer (Semantic Versioning) pattern.
e.g. 1.0.0, 1.0, v1.0.1 etc.
For more details on Semantic Versioning pattern go to this link: https://regex101.com/r/Ly7O1x/3/
Note: you can provide your own regex through the config file
To Enable Commenting, Disable Committing, Group changelog items and many more options Look at the config file docs.
To integrate Changelog CI with your repositories Actions,
Put this step inside your .github/workflows/workflow.yml file:
- name: Run Changelog CI
uses: saadmk11/changelog-ci@v0.7.0
with:
# Optional, you can provide any name for your changelog file,
# defaults to ``CHANGELOG.md`` if not provided.
changelog_filename: MY_CHANGELOG.md
# Optional, only required when you want more customization
# e.g: group your changelog by labels with custom titles,
# different version prefix, pull request title and version number regex etc.
config_file: changelog-ci-config.json
# Optional, This will be used to configure git
# defaults to ``github-actions[bot]`` if not provided.
committer_username: 'test'
committer_email: 'test@test.com'
env:
# optional, only required for ``private`` repositories
# and required if the changelog comment
# option is turned on through the config file
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
Changelog CI Badge:
Output:
Changelog CI Status
Changelog CI config file is a JSON file that you can provide to you workflow like this:
with:
config_file: changelog-ci-config.json
The config file will give you more flexibility and customization options.
version: in Version: 1.0.2true or false. if not provided defaults to true.
If it is set to true then Changelog CI will commit to the release pull request.true or false. if not provided defaults to false.
If it is set to true then Changelog CI will comment on the release pull request.
This requires GITHUB_TOKEN to be added to the workflow.regex Changelog CI will generate changelog for it.
Otherwise, it will skip the changelog generation.
If pull_request_title_regex is not provided defaults to ^(?i:release) (title must start with the word "release" (case insensitive)).regex tries to find the version number from the pull request title.
in case of no match, changelog generation will be skipped.
if version_regex is not provided defaults to SemVer pattern.
{
// Custom title for groups
"title": "Bug Fixes",
// pull request labels that will match this group
"labels": ["bug", "bugfix"]
}
See this example output with group_config
See this example output without group_config
{
"header_prefix": "Version:",
"commit_changelog": true,
"comment_changelog": true,
"pull_request_title_regex": "^Release",
"version_regex": "v?([0-9]{1,2})+[.]+([0-9]{1,2})+[.]+([0-9]{1,2})\\s\\(\\d{1,2}-\\d{1,2}-\\d{4}\\)",
"group_config": [
{
"title": "Bug Fixes",
"labels": ["bug", "bugfix"]
},
{
"title": "Code Improvements",
"labels": ["improvements", "enhancement"]
},
{
"title": "New Features",
"labels": ["feature"]
},
{
"title": "Documentation Updates",
"labels": ["docs", "documentation", "doc"]
}
]
}
In this Example version_regex matches any version number including date. e.g: v1.1.0 (01-23-2018)
If you don't provide any regex Changelog CI will use default
SemVer pattern. e.g. 1.0.1, v1.0.2.
Here pull_request_title_regex will match any pull request that starts with Release
you can match Any Pull Request Title by adding this pull_request_title_regex": ".*",
Click here to see the example output using this config
name: Changelog CI
# Controls when the action will run. Triggers the workflow on a pull request
on:
pull_request:
types: [opened, reopened]
jobs:
build:
runs-on: ubuntu-latest
steps:
# Checks-out your repository
- uses: actions/checkout@v2
- name: Run Changelog CI
uses: saadmk11/changelog-ci@v0.7.0
with:
changelog_filename: CHANGELOG.md
config_file: changelog-ci-config.json
# Add this if you are using it on a private repository
# Or if you have turned on commenting through the config file.
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
Changelog CI
The code in this project is released under the [MIT License](LICENSE).
*Note that all licence references and agreements mentioned in the Changelog CI README section above
are relevant to that project's source code only.
Do not miss the trending, packages, news and articles with our weekly report.