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(ci): introduce daily pre-releases #4535

Merged
merged 28 commits into from
Jun 20, 2024

Conversation

heitorlessa
Copy link
Contributor

@heitorlessa heitorlessa commented Jun 17, 2024

Issue number: #4506

Summary

Test CI: https://github.com/heitorlessa/aws-lambda-powertools-python/actions/runs/9547633628
PR sample: https://github.com/heitorlessa/aws-lambda-powertools-python/pull/437/files

This PR introduces a new workflow to release alpha releases (a.k.a pre-releases) on a daily basis. This is due to last release having an undetected regression that a canary and tests with optional dependencies could've prevented.

With pre-releases, we have the following benefits:

  1. Faster bugfix delivery for customers not wanting to wait the next release cycle. (note: bugs that affect most customers are delivered same day, that doesn't change it)
  2. Test our release pipeline daily (except Layers)
  3. Allows a future complex canary to test daily changes for timely feedback

Changes

Please provide a summary of what's being changed

  • Verify RELEASE_VERSION is a pre-release version to avoid accidental releases / pollution
  • Keep same steps and comments as much as possible from prod release
  • Create manual dispatch trigger
  • Create on schedule trigger
  • Test a release manually
  • Include provenance as part of release bump PR and src code
  • Adjust build-changelog to run after pre-release so we can trace it (workflow+docs)
  • Skip workflow if running on forks
  • Include provenance in PR
  • Create new trusted environment called pre-release to allow PyPi deployment
  • Create GitHub Actions environment named pre-release
  • Update install docs with tab on pre-releases to make it visible
  • Adjust schedule to weekdays
  • Update MAINTAINERS.md covering daily pre-release

Requirements matching

  • Confirm whether .alpha over poetry default .a is a deal breaker (nope)
  • Release every weekday early morning (on-call coverage, no impact to release day)
  • Do not touch CHANGELOG (avoid spam, doesn't affect stable release on what's in it)
  • PyPi only; do not release a new Lambda Layer (no alias yet, it'd impact versioning)
  • Create PR to update pyproject.toml and shared/version.py (ensure deterministic for next release)
  • Ensure it doesn't create a new release notes (avoid spam, provenance signing etc)
  • Always autoincrement pre-release version (keep it simple over substantial checking for changes, dep/runtime
    devs etc)
  • Run full quality check and test suite
  • Do not release docs for each pre-release (develop covers it, avoid dropdown UX issue)
  • Allow manual trigger a.k.a dispatch
  • Release to PyPi prod, not PyPi test (test pypi maintenance and supply chain differences)
  • Do not touch pending-release issues (no post-release prod tasks)

User experience

Please share what the user experience looks like before and after this change

image

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

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

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jun 17, 2024
@boring-cyborg boring-cyborg bot added the github-actions Pull requests that update Github_actions code label Jun 17, 2024
@github-actions github-actions bot added the internal Maintenance changes label Jun 17, 2024
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 17, 2024
@pull-request-size pull-request-size bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 17, 2024
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jun 17, 2024
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 17, 2024
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jun 17, 2024
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 17, 2024
@heitorlessa heitorlessa marked this pull request as ready for review June 17, 2024 17:08
@heitorlessa heitorlessa requested a review from a team June 17, 2024 17:08
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jun 17, 2024
@heitorlessa
Copy link
Contributor Author

heitorlessa commented Jun 17, 2024

one last change (tomorrow) but ready to review @leandrodamascena. I had to change the Install section to make this fit.

image image image image

Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

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

Hello @heitorlessa! We're making incredible progress in having pre-releases and allowing customers to test things before they go to production. Thanks for working on this, I couldn't do better than you did here.

I left some small changes and questions!

@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 17, 2024
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jun 17, 2024
Co-authored-by: Leandro Damascena <lcdama@amazon.pt>
Signed-off-by: Heitor Lessa <lessa@amazon.nl>
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 18, 2024
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jun 18, 2024
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 18, 2024
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jun 18, 2024
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
Signed-off-by: heitorlessa <lessa@amazon.co.uk>
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 20, 2024
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jun 20, 2024
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 20, 2024
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jun 20, 2024
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Jun 20, 2024
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Jun 20, 2024
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

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

AMAZING WORK @heitorlessa! ❤️

APPROVED!!!!

@leandrodamascena leandrodamascena merged commit 6782b6c into aws-powertools:develop Jun 20, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
github-actions Pull requests that update Github_actions code internal Maintenance changes size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants