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

chore: add release drafter automation #568

Merged
merged 4 commits into from
Apr 11, 2023
Merged

Conversation

wesk
Copy link
Collaborator

@wesk wesk commented Feb 21, 2023

This PR adds the following two workflows:

  1. Release Drafter
    1. Automatically drafts our next GitHub release notes with each push to main
    2. Automatically proposes a new version number as a minor or patch release
    3. Based on the implementation in feat: add release drafter aws-powertools/powertools-lambda-python#56
  2. Third-party workflow version pin validator
    1. Automatically validates that all third-party workflows run with a pinned version hash
    2. Based on the implementation in chore(ci): lockdown 3rd party workflows to pin sha aws-powertools/powertools-lambda-python#1301

Manual steps still required for each release:

  1. Confirm that each PR title accurately captures the scope of the change. Make sure PRs are labeled as feat: or fix: etc. correctly
  2. Add labels to each PR corresponding to the type of PR that it is. Release drafter functions based on the label.
  3. Re-run the Release Drafter workflow after updating labels to ensure the release draft picks up the changes.
  4. Fill in the "What's New" section of the GitHub release before releasing
  5. Manually update the CHANGELOG file before each release
  6. Verify that the inferred release version that Release Drafter proposes is correct

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@codecov
Copy link

codecov bot commented Feb 22, 2023

Codecov Report

Patch coverage has no change and project coverage change: +0.33 🎉

Comparison is base (e603687) 64.76% compared to head (f8da144) 65.09%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #568      +/-   ##
==========================================
+ Coverage   64.76%   65.09%   +0.33%     
==========================================
  Files         341      363      +22     
  Lines       25538    26532     +994     
==========================================
+ Hits        16539    17271     +732     
- Misses       8999     9261     +262     

see 108 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@wesk wesk force-pushed the 2023-02-20-add-release-drafter branch from 1658075 to 5c52870 Compare February 24, 2023 13:58
.github/CODEOWNERS Outdated Show resolved Hide resolved
@wesk wesk requested a review from mseeger April 6, 2023 06:19
@wesk wesk marked this pull request as ready for review April 6, 2023 06:19
Copy link
Collaborator

@mseeger mseeger left a comment

Choose a reason for hiding this comment

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

I suggest to give this a try, by doing another release quite soon. Can be a patch release again.

@wesk
Copy link
Collaborator Author

wesk commented Apr 11, 2023

Will do, thanks!

@wesk wesk merged commit 7df7640 into main Apr 11, 2023
@wesk wesk deleted the 2023-02-20-add-release-drafter branch April 11, 2023 14:42
@wesk wesk added the chore label Apr 11, 2023
@wesk wesk mentioned this pull request Apr 11, 2023
@wesk
Copy link
Collaborator Author

wesk commented Apr 11, 2023

I suggest to give this a try, by doing another release quite soon. Can be a patch release again.

PR for a new release: #620

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants