ASK

README.md

@@ -25,7 +25,7 @@ CodiumAI `PR-Agent` is an open-source tool aiming to help developers review pull
 \
 ‣ **Code Suggestions ([`/improve`](./docs/IMPROVE.md))**: Committable code suggestions for improving the PR.
 \
-‣ **Update Changelog (`/update_changelog`)**: Automatically updating the CHANGELOG.md file with the [PR changes](https://github.com/Codium-ai/pr-agent/pull/168#discussion_r1282077645).
+‣ **Update Changelog ([`/update_changelog`](./docs/UPDATE_CHANGELOG.md))**: Automatically updating the CHANGELOG.md file with the PR changes.
 \
 ‣ **Find similar issue ([`/similar_issue`](./docs/SIMILAR_ISSUE.md))**: Automatically retrieves and presents similar issues
 

docs/TOOLS_GUIDE.md

@@ -4,3 +4,4 @@
 - [IMPROVE](./IMPROVE.md)
 - [ASK](./ASK.md)
 - [SIMILAR_ISSUE](./SIMILAR_ISSUE.md)
+- [UPDATE CHANGELOG](./UPDATE_CHANGELOG.md)

docs/UPDATE_CHANGELOG.md

@@ -0,0 +1,19 @@
+# Update Changelog Tool
+
+The `update_changelog` tool automatically updates the CHANGELOG.md file with the PR changes.
+It can be invoked manually by commenting on any PR:
+```
+/update_changelog
+```
+For example:
+
+<kbd><img src=./../pics/update_changelog_comment.png width="768"></kbd>
+<kbd><img src=./../pics/update_changelog.png width="768"></kbd>
+
+
+### Configuration options
+
+Under the section 'pr_update_changelog', the [configuration file](./../pr_agent/settings/configuration.toml#L50) contains options to customize the 'update changelog' tool:
+
+- `push_changelog_changes`: whether to push the changes to changelog changes, or just print them. Default is false (print only).
+- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...