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 generation workflow #1519

Closed
wants to merge 9 commits into from

Conversation

SachinSahu431
Copy link
Contributor

@SachinSahu431 SachinSahu431 commented May 19, 2024

Describe your PR

This PR implements a changelog generation workflow. The proposed workflow aims to automate changelog entries, enhance accuracy, and reduce manual efforts.

The idea here is to have a Changelog section in the PR template. The author will use this section to write about the changes introduced in their PR. The type of change will be obtained from the labels associated with the PR.

When a release branch is created, a GitHub action will be triggered, which will aggregate changelog entries from all the commits made after the previous release, and raise an automated PR. This aggregated changelog entry will be added under the ‘Unreleased’ section of the CHANGELOG.md. This will allow the maintainer to edit it anytime quickly.

Please refer to Changelog Automation proposal for more information.

What type of PR is this?

/kind release-note-none

Changelog Entry

NONE

Related

This requires the other PRs to be merged:
#1517 #1518

Closes #1434

Signed-off-by: Sachin Sahu <75629410+SachinSahu431@users.noreply.github.com>
Copy link
Member

@kakkoyun kakkoyun left a comment

Choose a reason for hiding this comment

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

LGTM. We need to see it in action. Do you have any screenshots?

Signed-off-by: Sachin Sahu <75629410+SachinSahu431@users.noreply.github.com>
Copy link
Member

@ArthurSens ArthurSens left a comment

Choose a reason for hiding this comment

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

Things we discussed in our call today

  • Let's include the release-branch in the PR title, so it's easier to understand what this changelog PR is about
  • Let's add commit range diff between the previous review and what it is being included in the new release

.github/workflows/changelog-generation.yml Outdated Show resolved Hide resolved
Signed-off-by: Sachin Sahu <75629410+SachinSahu431@users.noreply.github.com>
@SachinSahu431
Copy link
Contributor Author

Thanks for the review!

Here is one dummy PR that is created by this workflow: SachinSahu431#55

Screenshots:
image
image
image

Signed-off-by: Sachin Sahu <75629410+SachinSahu431@users.noreply.github.com>
SachinSahu431 and others added 4 commits May 28, 2024 09:01
Signed-off-by: Sachin Sahu <75629410+SachinSahu431@users.noreply.github.com>
Signed-off-by: Sachin Sahu <sachinksahu.431@gmail.com>
Signed-off-by: Sachin Sahu <sachinksahu.431@gmail.com>
Signed-off-by: Sachin Sahu <75629410+SachinSahu431@users.noreply.github.com>
Signed-off-by: Sachin Sahu <75629410+SachinSahu431@users.noreply.github.com>
@SachinSahu431
Copy link
Contributor Author

According to the feedback received, I've made adjustments to the workflow so that it only triggers on release branches when the VERSION file is modified. Additionally, the Changelog file will now have an updated header with the latest version and date.

@bwplotka
Copy link
Member

Sounds this work was paused. That's ok, we learned so much! We also removed other half finished CI jobs to avoid confusion. Thanks for all the work! We can get back to this one day 💪🏽

@bwplotka bwplotka closed this Jul 30, 2024
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.

Changelog automation
4 participants