Skip to content

Adds github action to verify changelog entry and set milestone to PRs#14279

Merged
stefanvodita merged 3 commits intoapache:mainfrom
pseudo-nymous:changelog-verifier-milestone-setter-prod
Feb 28, 2025
Merged

Adds github action to verify changelog entry and set milestone to PRs#14279
stefanvodita merged 3 commits intoapache:mainfrom
pseudo-nymous:changelog-verifier-milestone-setter-prod

Conversation

@pseudo-nymous
Copy link
Contributor

@pseudo-nymous pseudo-nymous commented Feb 23, 2025 •
edited
Loading

Description

Adds github action workflow to verify change log entry and set milestone based on the location of change log entry.

This workflow does the following step by step:

  1. Check if the PR has skip changelog label to skip the further steps. Committers should add this label if they want skip adding change log entry. This is helpful when change log entry is not required.
  2. Verifies if there is an entry in change log file (lucene/CHANGES.txt).
  3. Extracts the milestone version based on the location of the change log entry.
  4. Checks if the milestone exist in github then applies (adds/updates) the milestone version to the PR.
  5. Flags if milestone version do not exist. Currently, we are only logging it. We can either add a comment to create the milestone or create one automatically if a new banner is created (=== Lucene XXX ===) under change log file.

Currently, I have only added logs in the action workflow testing all the flow. It's not blocking the merging process.
We can make it blocking based on the discussion in this PR.

Tested changes here: pseudo-nymous#13

Closes: #13898 #14190

@pseudo-nymous pseudo-nymous force-pushed the changelog-verifier-milestone-setter-prod branch from cded4ed to 55d89f7 Compare February 23, 2025 20:08
stefanvodita
stefanvodita reviewed Feb 23, 2025
View reviewed changes
Copy link
Contributor

@stefanvodita stefanvodita left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great work and really helpful @pseudo-nymous! I left some comments, but I'm looking forward to seeing this in action.

@pseudo-nymous pseudo-nymous force-pushed the changelog-verifier-milestone-setter-prod branch from fd02d5f to 00c4469 Compare February 24, 2025 12:39
@pseudo-nymous pseudo-nymous force-pushed the changelog-verifier-milestone-setter-prod branch from 00c4469 to ce605d2 Compare February 24, 2025 13:04
@dweiss
Copy link
Contributor

dweiss commented Feb 24, 2025

Please do not force-push your changes. Keep prior commits so that the history is preserved and comments are attached where they should be. Thanks!

@pseudo-nymous
Copy link
Contributor Author

pseudo-nymous commented Feb 24, 2025

There were small fixes which I missed in previous commit. This didn't had any history attached to it and I kept the commit which had comments.

Also, I'll keep this in check in next time. Thanks

@stefanvodita
Copy link
Contributor

stefanvodita commented Feb 25, 2025

Thank you for making the changes @pseudo-nymous! I think once we make the action use the new label I created we're ready to test this out.

@pseudo-nymous
Copy link
Contributor Author

pseudo-nymous commented Feb 25, 2025

I have updated the script to use new label. We are ready to test the changes.

stefanvodita
stefanvodita approved these changes Feb 25, 2025
View reviewed changes
Copy link
Contributor

@stefanvodita stefanvodita left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! If no one objects, I'll merge in the next few days and we can see how it runs. If we like what we see in the logs, we can come back and enable it to set milestones and comment on the PR.

@stefanvodita stefanvodita merged commit e50fb7f into apache:main Feb 28, 2025
6 checks passed
@stefanvodita stefanvodita mentioned this pull request Mar 2, 2025
Closed
hanbj pushed a commit to hanbj/lucene that referenced this pull request Mar 12, 2025
@pseudo-nymous @hanbj
Adds github action to verify changelog entry and set milestone to PRs (…
34bb4f6 
…apache#14279)
pseudo-nymous added a commit to pseudo-nymous/lucene that referenced this pull request Mar 16, 2025
@pseudo-nymous
Adds github action to verify changelog entry and set milestone to PRs (…
fa083ff 
…apache#14279)
pseudo-nymous added a commit to pseudo-nymous/lucene that referenced this pull request Mar 16, 2025
@pseudo-nymous
Adds github action to verify changelog entry and set milestone to PRs (…
4a640e0 
…apache#14279)
pseudo-nymous added a commit to pseudo-nymous/lucene that referenced this pull request Mar 16, 2025
@pseudo-nymous
Adds github action to verify changelog entry and set milestone to PRs (…
6f7e608 
…apache#14279)
@javanna
Copy link
Contributor

javanna commented Mar 19, 2025

Hey @stefanvodita the changelog entry for this was filed under 10.2, but I don't believe the change itself was backported. Can you double check and either backport or move the changelog entry? Thanks!

@stefanvodita
Copy link
Contributor

stefanvodita commented Mar 21, 2025

Thanks for pointing that out @javanna! Funny how that happened on a PR that's specifically about the changelog. We should only push this to main. I'll actually delete the entry for now since we're still iterating on this workflow to make it work. See #13898.

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

Reviewers

@stefanvodita stefanvodita stefanvodita approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Create a bot to check if there is a CHANGES entry for new PRs

4 participants

@pseudo-nymous @dweiss @stefanvodita @javanna