Skip to content

Fixing changelog entry#19594

Merged
jainankitk merged 1 commit intoopensearch-project:3.3from
jainankitk:fix-chlog
Oct 10, 2025
Merged

Fixing changelog entry#19594
jainankitk merged 1 commit intoopensearch-project:3.3from
jainankitk:fix-chlog

Conversation

@jainankitk
Copy link
Copy Markdown
Contributor

Description

Adds the changelog entry for this PR - #19593

Related Issues

Resolves #[Issue number to be closed when this PR is merged]

Check List

  • Functionality includes testing.
  • API changes companion pull request created, if applicable.
  • Public documentation issue/PR created, if applicable.

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.

Signed-off-by: Ankit Jain <jainankitk@apache.org>
@jainankitk jainankitk merged commit e972d15 into opensearch-project:3.3 Oct 10, 2025
32 checks passed
@andrross
Copy link
Copy Markdown
Member

@jainankitk The changelog on the 3.3 branch should be empty as all changes will be released in 3.3. After the release, the only entries in the 3.3 changelog would be any changes to go in a 3.3.1 patch (if such a patch release were needed).

@jainankitk jainankitk deleted the fix-chlog branch October 10, 2025 18:18
@jainankitk
Copy link
Copy Markdown
Contributor Author

@jainankitk The changelog on the 3.3 branch should be empty as all changes will be released in 3.3. After the release, the only entries in the 3.3 changelog would be any changes to go in a 3.3.1 patch (if such a patch release were needed).

I was just trying to keep things consistent, since other entries were not removed. Ideally we should update the release notes generation workflow to update CHANGELOG as well at the same time?

@peterzhuamazon
Copy link
Copy Markdown
Member

Hi @jainankitk @andrross

Since we start using the autogen AI workflows from infra side to generate release notes for every component,
I wonder if we still need the changelog.md?

  1. It cause conflicts previously and every update to it will go through gradle check
  2. Our workflow will autogen based on commit msgs, if the changelog.md exist it will skip and just skip commit msgs and take directly from changelog.md.

Thanks.

@cwperks
Copy link
Copy Markdown
Member

cwperks commented Oct 10, 2025

@peterzhuamazon I think that would be our single biggest improvement for engineering efficiency. Only comment I would have are:

  • Would the skip-changelog label be honored? For instance I don't think this PR needs an entry
  • We need to educate maintainers to make sure the commit message is formed well on squash and merge (or potentially Github will have smart summarization soon?)

@peterzhuamazon
Copy link
Copy Markdown
Member

peterzhuamazon commented Oct 10, 2025

@cwperks the autogen logic is simple.
If changelog.md does not exist, take everything in commit history from last release to HEAD and create release notes.
Else if will just copy from changelog.md.

I guess one way is to improve our workflows here is to add an --exclude option for certain keyword in commit msg.

Then if any PR title (since we squash and PR title becomes final commit msg) contains these:

[NFC] - "No Functional Change"
[nit] - Short for "nitpick," indicating a tiny change
[chore] - Minor maintenance work
[trivial] - Self-explanatory minor change

We will just ignore them in the release notes.

Thanks.

@peterzhuamazon
Copy link
Copy Markdown
Member

peterzhuamazon commented Oct 10, 2025

As for educating the maintainers, I guess at least the PR title needs to be precise and detailed enough, so that LLM can improve them upon. I think since we are using LLM this step is not as hard as we think, just informing people to add [NIT] or [Chore] should be the only requirement if we implement above.

@andrross
Copy link
Copy Markdown
Member

@cwperks @peterzhuamazon Let's move the discussion to #19600

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants