Skip to content

Commit 9710c7c

Browse files
committed
Replace CHANGELOG.md with release-notes/AGENTS.md
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>
1 parent 0537405 commit 9710c7c

File tree

5 files changed

+170
-118
lines changed

5 files changed

+170
-118
lines changed

.gitattributes

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,3 @@
1212
*.p12 binary
1313
*.ttf binary
1414
*.txt text=auto
15-
CHANGELOG.md merge=union

CHANGELOG.md

Lines changed: 0 additions & 89 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
- [Documentation Changes](#documentation-changes)
77
- [Contributing Code](#contributing-code)
88
- [Developer Certificate of Origin](#developer-certificate-of-origin)
9-
- [Changelog](#changelog)
109
- [Review Process](#review-process)
1110
- [Tips for Success](#tips)
1211
- [Troubleshooting Failing Builds](#troubleshooting-failing-builds)
@@ -119,33 +118,6 @@ Signed-off-by: Jane Smith <jane.smith@email.com>
119118
```
120119
You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `-s` or `--signoff` to add the `Signed-off-by` line to the end of the commit message.
121120

122-
## Changelog
123-
124-
OpenSearch maintains version specific changelog by enforcing a change to the ongoing [CHANGELOG](CHANGELOG.md) file adhering to the [Keep A Changelog](https://keepachangelog.com/en/1.0.0/) format. The purpose of the changelog is for the contributors and maintainers to incrementally build the release notes throughout the development process to avoid a painful and error-prone process of attempting to compile the release notes at release time. On each release the "unreleased" entries of the changelog are moved to the appropriate release notes document in the `./release-notes` folder. Also, incrementally building the changelog provides a concise, human-readable list of significant features that have been added to the unreleased version under development.
125-
126-
### Which changes require a CHANGELOG entry?
127-
Changelogs are intended for operators/administrators, developers integrating with libraries and APIs, and end-users interacting with OpenSearch Dashboards and/or the REST API (collectively referred to as "user"). In short, any change that a user of OpenSearch might want to be aware of should be included in the changelog. The changelog is _not_ intended to replace the git commit log that developers of OpenSearch itself rely upon. The following are some examples of changes that should be in the changelog:
128-
129-
- A newly added feature
130-
- A fix for a user-facing bug
131-
- Dependency updates
132-
- Fixes for security issues
133-
134-
The following are some examples where a changelog entry is not necessary:
135-
136-
- Adding, modifying, or fixing tests
137-
- An incremental PR for a larger feature (such features should include _one_ changelog entry for the feature)
138-
- Documentation changes or code refactoring
139-
- Build-related changes
140-
141-
Any PR that does not include a changelog entry will result in a failure of the validation workflow in GitHub. If the contributor and maintainers agree that no changelog entry is required, then the `skip-changelog` label can be applied to the PR which will result in the workflow passing.
142-
143-
### How to add my changes to [CHANGELOG](CHANGELOG.md)?
144-
145-
Adding in the change is two step process:
146-
1. Add your changes to the corresponding section within the CHANGELOG file with dummy pull request information, publish the PR
147-
2. Update the entry for your change in [`CHANGELOG.md`](CHANGELOG.md) and make sure that you reference the pull request there.
148-
149121
## Review Process
150122

151123
We deeply appreciate everyone who takes the time to make a contribution. We will review all contributions as quickly as possible. As a reminder, [opening an issue](https://github.com/opensearch-project/OpenSearch/issues/new/choose) discussing your change before you make it is the best way to smooth the PR process. This will prevent a rejection because someone else is already working on the problem, or because the solution is incompatible with the architectural direction.

RELEASING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
## Releasing
22

33
This project follows [OpenSearch project branching, labelling, and releasing](https://github.com/opensearch-project/.github/blob/main/RELEASING.md).
4+
5+
### Release Notes
6+
7+
The [release notes AGENTS.md file](release-notes/AGENTS.md) is intended to be given to an AI agent as a prompt. It will generate release notes and create a pull request. The agent will need to access commit information from the local git repository as well as permissions to read pull request descriptions and create a new pull request in GitHub.

0 commit comments

Comments
 (0)