Replace CHANGELOG.md with release-notes/AGENTS.md#20974
Replace CHANGELOG.md with release-notes/AGENTS.md#20974andrross wants to merge 1 commit intoopensearch-project:mainfrom
Conversation
Use an AI agent steering file to generate release notes from commit messages, PR descriptions, and PR labels. Signed-off-by: Andrew Ross <andrross@amazon.com>
PR Code Analyzer ❗AI-powered 'Code-Diff-Analyzer' found issues on commit 9710c7c.
The table above displays the top 10 most important findings. Pull Requests Author(s): Please update your Pull Request according to the report above. Repository Maintainer(s): You can Thanks. |
|
@peterzhuamazon @gaiksaya @rishabh6788 What do you think about integrating some of the things in the prompt here into https://github.com/opensearch-project/opensearch-build/blob/main/src/llms/prompts.py ? |
Use an AI agent steering file to generate release notes from commit messages, PR descriptions, and PR labels.
Here is an example PR using kiro-cli with Claude Opus 4.6
This has quite a lot of overlap with the existing AI-generated release notes tooling. There are key differences in the prompt. Namely that for this repo I think it's pretty important to filter out commits that are not important to users, as opposed to the strict one-entry-per-commit policy. There are also a policies like filtering out commit/revert pairs, collapsing multiple version updates to the same dependency, etc. This version also puts explanation about judgement calls into the PR description, giving human reviews some specific things to look at.
The other main difference is that this relies on an agent to do the work of getting commits and scraping the GitHub API, as opposed to scripting it. There are some subtleties with getting the correct commits for a release given that the previous release branch overlaps with main for the duration of the release window. The agent seemed to be pretty good at figuring this out.
I would like to see if we can integrate some of these changes into the automation in the build repo and then maybe not need this. At least in the short term this seems like a pretty good improvement over the CHANGELOG!
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.