Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

pseudo-nymous
Copy link
Contributor

@pseudo-nymous pseudo-nymous commented Feb 23, 2025

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
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

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 stefanvodita added the skip-changelog-check Apply to PRs that don't need a changelog entry to stop the automated changelog check. label Feb 25, 2025
@stefanvodita
Copy link
Contributor

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

I have updated the script to use new label. We are ready to test the 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog-check Apply to PRs that don't need a changelog entry to stop the automated changelog check.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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