Update Changelog
Overview¶
The update_changelog
tool automatically updates the CHANGELOG.md file with the PR changes.
It can be invoked manually by commenting on any PR:
Example usage¶
Configuration options¶
Under the section pr_update_changelog
, the configuration file contains options to customize the 'update changelog' tool:
push_changelog_changes
: whether to push the changes to CHANGELOG.md, or just publish them as a comment. Default is false (publish as comment).extra_instructions
: Optional extra instructions to the tool. For example: "Use the following structure: ..."add_pr_link
: whether the model should try to add a link to the PR in the changelog. Default is true.skip_ci_on_push
: whether the commit message (whenpush_changelog_changes
is true) will include the term "[skip ci]", preventing CI tests to be triggered on the changelog commit. Default is true.