update_changelog tool automatically updates the CHANGELOG.md file with the PR changes.
How to use the update_changelog tool
Manual usage
Comment on the PR:
Configuration options
Configure theupdate_changelog tool by setting configurations under the pr_update_changelog part in your configuration file.
| Possible configurations | Default value | What they do |
|---|---|---|
push_changelog_changes | false (publish as a comment) | Choose whether to push the changes to CHANGELOG.md, or publish them as a comment.Not supported on Gitlab |
extra_instructions | none | Optional extra instructions for the tool. For example: “focus on the changes in the file X”, “Ignore changes in …” |
add_pr_link | true | Choose whether to add a link to the PR in the changelog. |
skip_ci_on_push | true | Choose whether the commit message will include the term [skip ci], preventing CI tests to be triggered on the changelog commit. |
Example usage
