Skip to content

chore(ci): increase release automation and limit to one manual step#1297

Merged
heitorlessa merged 11 commits intoaws-powertools:developfrom
heitorlessa:chore/changelog-automate
Jul 18, 2022
Merged

chore(ci): increase release automation and limit to one manual step#1297
heitorlessa merged 11 commits intoaws-powertools:developfrom
heitorlessa:chore/changelog-automate

Conversation

@heitorlessa
Copy link
Copy Markdown
Contributor

@heitorlessa heitorlessa commented Jul 14, 2022 •
edited by markdownify bot
Loading

Issue number: #1009

Summary

Changes

Please provide a summary of what's being changed

This PR reduces operational overhead when releasing a new version by restricting manual steps to a single job: Drafting release notes.

Main changes

  • Changelog generation and version bump are now part of the release process
  • Release process can be triggered manually in case of GH Actions intermittent failures with builds to start
  • Split release jobs into three to ease further maintenance: 1/ release PyPi/SAR, 2/ docs, 3/ post release

User experience

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

Checklist

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

Tasks

  • Remove version checking
  • Push staged files pyproject/changelog to trunk
  • Prevent concurrent docs pushing different changelog versions
  • Split docs and auto-close issues
  • Update manual x automated activities step
  • Split jobs to ease further maintenance
    • Make sure git is configured in separate job just in case
  • Update failure mechanism
  • Update MAINTAINERS.md release steps
  • Include manual dispatch for failures

Separate PR to limit failure radius

  • Make docs build workflow reusable
  • Include changelog bump on every PR merge (unreleased section)
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.

View rendered .chglog/CHANGELOG.tpl.md
View rendered MAINTAINERS.md

@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 14, 2022
@boring-cyborg boring-cyborg bot added github-actions Pull requests that update Github_actions code internal Maintenance changes labels Jul 14, 2022
@heitorlessa
Copy link
Copy Markdown
Contributor Author

heitorlessa commented Jul 14, 2022

@rubenfonseca @leandrodamascena -- need your input the most here. Please let me know if this is clear, and whether there are any areas you want to me further document now (or later?).

leandrodamascena
leandrodamascena reviewed Jul 14, 2022
View reviewed changes
leandrodamascena
leandrodamascena reviewed Jul 14, 2022
View reviewed changes
@leandrodamascena
Copy link
Copy Markdown
Contributor

leandrodamascena commented Jul 14, 2022

Hello @heitorlessa. Thanks for tagging me.
I added two comments but this PR looks amazing. This will reduce friction in the manual steps and make things more automated.

This PR makes announcing new releases even more interesting as it automates all the work in the repository and allows for human interaction by writing text (and with images) announcing the release.

I can't think of anything to add to the documentation right now. But I'll let you know if I think of anything new.

Congrats 💯 🚀

@heitorlessa heitorlessa changed the title chore(ci): remove version lock on changelog generation chore(ci): increase release automation and limit to one manual step Jul 14, 2022
@heitorlessa heitorlessa mentioned this pull request Jul 14, 2022
Closed
35 tasks
@heitorlessa
Copy link
Copy Markdown
Contributor Author

heitorlessa commented Jul 14, 2022

@rubenfonseca need your approval before I fix a conflict and merge

@heitorlessa
Merge branch 'develop' into chore/changelog-automate
ab19c1a 
* develop:
  chore(deps): bump jsii from 1.61.0 to 1.62.0 (aws-powertools#1294)
  chore(ci): experiment with conditional on outputs
  chore(ci): improve error handling for non-issue numbers
  fix(ci): address conditional type on_merge
  chore(ci): add end to end testing mechanism (aws-powertools#1247)
  chore(deps-dev): bump mypy-boto3-appconfig from 1.24.0 to 1.24.29 (aws-powertools#1295)
@heitorlessa
Merge branch 'chore/changelog-automate' of https://github.com/heitorl…
76cf696 
…essa/aws-lambda-powertools-python into chore/changelog-automate

* 'chore/changelog-automate' of https://github.com/heitorlessa/aws-lambda-powertools-python:
rubenfonseca
rubenfonseca approved these changes Jul 14, 2022
View reviewed changes
Copy link
Copy Markdown
Contributor

@rubenfonseca rubenfonseca left a comment

Choose a reason for hiding this comment

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

This is great work. Have you considered writing a book on Github Actions automation? 💯

@heitorlessa heitorlessa merged commit 29c2403 into aws-powertools:develop Jul 18, 2022
@heitorlessa heitorlessa deleted the chore/changelog-automate branch July 18, 2022 07:04
@heitorlessa heitorlessa mentioned this pull request Jul 25, 2022
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@leandrodamascena leandrodamascena leandrodamascena left review comments

@am29d am29d Awaiting requested review from am29d

+1 more reviewer

@rubenfonseca rubenfonseca rubenfonseca approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

github-actions Pull requests that update Github_actions code internal Maintenance changes size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@heitorlessa @leandrodamascena @rubenfonseca