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

Add release drafter github action #1416

Merged
merged 22 commits into from Jun 20, 2021
Merged

Add release drafter github action #1416

merged 22 commits into from Jun 20, 2021

Conversation

ssbarnea
Copy link
Member

@ssbarnea ssbarnea commented Jun 11, 2021

This change should help preparing list of release notes for future
releases. When a maintainer will want to make a release he would
be able to tune the draft release notes and copy them to the
changelog.

The biggest advantage of this change is that the creation of the
draft is automated and it already uses the desired format, with
title link to PR and mention of author, reducing the maintenance
chore when preparing for a new release.

Changelog-friendly one-liner:

Contributor checklist
  • Provided the tests for the changes.
  • Gave a clear one-line description in the PR (that the maintainers can add to CHANGELOG.md on release).
  • Assign the PR to an existing or new milestone for the target version (following Semantic Versioning).

This change should help preparing list of release notes for future
releases. When a maintainer will want to make a release he would
be able to tune the draft release notes and copy them to the
changelog.

The biggest advantage of this change is that the creation of the
draft is automated and it already uses the desired format, with
title link to PR and mention of author, reducing the maintenance
chore when preparing for a new release.
@ssbarnea ssbarnea added this to the 6.2.0 milestone Jun 11, 2021
@ssbarnea ssbarnea marked this pull request as ready for review June 11, 2021 15:05
@ssbarnea ssbarnea requested a review from webknjaz June 11, 2021 15:06
Copy link
Member

@atugushev atugushev left a comment

Choose a reason for hiding this comment

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

Wow, that looks pretty useful! A few notes below:

.github/release-drafter.yml Outdated Show resolved Hide resolved
.github/workflows/labels.yml Outdated Show resolved Hide resolved
@atugushev atugushev added the maintenance Related to maintenance processes label Jun 11, 2021
@jezdez

This comment has been minimized.

@jezdez

This comment has been minimized.

@atugushev

This comment has been minimized.

@webknjaz

This comment has been minimized.

@jezdez

This comment has been minimized.

Copy link
Member

@jezdez jezdez left a comment

Choose a reason for hiding this comment

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

For the record, this needs to lose the use of the verify-pr-label-action action to be mergable. Release-drafter is already used in other Jazzband projects and is acceptable.

@ssbarnea ssbarnea requested a review from jezdez June 14, 2021 12:14
@ssbarnea
Copy link
Member Author

@atugushev @jezdez Does it look ok now? Did I miss anything or is ready for approval. I can wait for two approvals for this one if you think that is needed.

@ssbarnea
Copy link
Member Author

@atugushev Can you please review this? I would like to enable it so we can benefit from it for the new release.

Copy link
Member

@atugushev atugushev left a comment

Choose a reason for hiding this comment

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

Thanks for pinging! A few notes below:

.github/release-drafter.yml Outdated Show resolved Hide resolved
.github/release-drafter.yml Outdated Show resolved Hide resolved
.github/release-drafter.yml Outdated Show resolved Hide resolved
.github/release-drafter.yml Outdated Show resolved Hide resolved
@ssbarnea
Copy link
Member Author

@atugushev Please give it another go, I hope I addressed all comments.

Copy link
Member

@atugushev atugushev left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Co-authored-by: Sviatoslav Sydorenko <webknjaz@redhat.com>
Copy link
Member

@jezdez jezdez left a comment

Choose a reason for hiding this comment

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

Tiny change to the action config needed, but otherwise this looks good to me.

.github/workflows/release-drafter.yml Outdated Show resolved Hide resolved
@ssbarnea ssbarnea requested a review from jezdez June 20, 2021 09:39
@ssbarnea
Copy link
Member Author

@jezdez Added that change. Please do not forget to approve it. As long you appear with "requested changes" we will not be able to merge the change, regardless other approvals.

@jezdez
Copy link
Member

jezdez commented Jun 20, 2021

@jezdez Added that change. Please do not forget to approve it. As long you appear with "requested changes" we will not be able to merge the change, regardless other approvals.

Yep, that's how it was intended. Thanks for working on this @ssbarnea!

@ssbarnea ssbarnea merged commit 608572f into master Jun 20, 2021
@atugushev atugushev deleted the release-6.2.0 branch June 21, 2021 05:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Related to maintenance processes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants