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

Changelog Automation for Squash and Merge commit messages #28747

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rcskosir
Copy link
Contributor

Community Note

  • Please vote on this PR by adding a 👍 reaction to the original PR to help the community and maintainers prioritize for review
  • Please do not leave comments along the lines of "+1", "me too" or "any updates", they generate extra noise for PR followers and do not help prioritize for review

Description

Adding the GitHub actions and the go script for the changelog automation.
When a PR is merged using squash and merge, the text from the body of the squash and merge is checked for a changelog entry.

It is checking for [BUG], [ENHANCEMENT], or [FEATURE]. Breaking changes need to be added to the changelog manually.
The automation will add the [GH-12345] to the end of the entry.

The automation will check if a PR is already open for the next release. If one is open, it will add the entry under the first matching header. If a PR is not already open, it will open a PR on a branch called automated-changelog, update the headers, and add the new entry. It does NOT currently add entries/sort entries in alphabetical order, that is a future enhancement.

PR Checklist

  • I have followed the guidelines in our Contributing Documentation.
  • I have checked to ensure there aren't other open Pull Requests for the same update/change.
  • I have checked if my changes close any open issues. If so please include appropriate closing keywords below.
  • I have updated/added Documentation as required written in a helpful and kind way to assist users that may be unfamiliar with the resource / data source.
  • I have used a meaningful PR title to help maintainers and other users understand this change and help prevent duplicate work.
    For example: “resource_name_here - description of change e.g. adding property new_property_name_here

This is a (please select all that apply):

  • Bug Fix
  • New Feature (ie adding a service, resource, or data source)
  • Enhancement
  • Breaking Change

Note

If this PR changes meaningfully during the course of review please update the title and description as required.

@rcskosir rcskosir requested a review from a team as a code owner February 11, 2025 16:39
@rcskosir rcskosir added changelog Label for the automated changelog tooling and removed changelog Label for the automated changelog labels Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant