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 automation to update getting started guide #1238

Conversation

austinvazquez
Copy link
Contributor

@austinvazquez austinvazquez commented May 16, 2024

Issue #, if available:
Updating the version in the getting started guide is currently a manual step for every release. It would be nice to have automation to generate the PR so maintainers only have to approve and merge the pull request.

Description of changes:
This change adds a workflow to open a pull request to update the version in the getting started guide when a release is made.

Testing performed:
Pushed workflow to fork and created a release tag to show workflow opened a PR to update the getting started version.

Automated version PR - austinvazquez#29
Release used to trigger automation - https://github.com/austinvazquez/soci-snapshotter/releases/tag/v0.6.1-alpha.0
GitHub Action workflow run - https://github.com/austinvazquez/soci-snapshotter/actions/runs/9208357812

Mock workflow runs in pull request on changes to GitHub Actions workflow file and asserts the changes are made to update the version.

Alternatives considered:

  1. An approach which creates the PR once the release tag is pushed. i.e. the existing release workflow
    a. The trade-off is the release artifacts will not yet be published. Although this is mitigated because the PR still requires manual approval and publishing a tag is a one-way door, to avoid confusion it would be good to only update the getting started version once the artifact is publicly available.

Limitations:

  1. Similar to the existing update dependencies automation, the PR must be closed and reopened for workflow checks to run.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@austinvazquez austinvazquez force-pushed the add-update-getting-started-guide-automation branch 4 times, most recently from bea278c to 59fbc1b Compare May 16, 2024 12:33
@austinvazquez austinvazquez marked this pull request as ready for review May 16, 2024 12:34
@austinvazquez austinvazquez requested a review from a team as a code owner May 16, 2024 12:34
@austinvazquez austinvazquez marked this pull request as draft May 16, 2024 17:25
@austinvazquez austinvazquez force-pushed the add-update-getting-started-guide-automation branch 2 times, most recently from 19bdc44 to e64373f Compare May 23, 2024 12:48
@austinvazquez austinvazquez marked this pull request as ready for review May 23, 2024 12:58
@austinvazquez austinvazquez force-pushed the add-update-getting-started-guide-automation branch from e64373f to 4734764 Compare May 23, 2024 13:02
@austinvazquez austinvazquez force-pushed the add-update-getting-started-guide-automation branch from 4734764 to 0615443 Compare May 23, 2024 14:49
@sondavidb
Copy link
Contributor

IMO it wouldn't be a bad idea to also include automation to update third-party licenses in this workflow. This will get run on patch versions and patch versions can potentially have different versions which could potentially have different licenses. Definitely not likely at all but a possibility that could be a problem if not caught IMO.

@austinvazquez
Copy link
Contributor Author

IMO it wouldn't be a bad idea to also include automation to update third-party licenses in this workflow. This will get run on patch versions and patch versions can potentially have different versions which could potentially have different licenses. Definitely not likely at all but a possibility that could be a problem if not caught IMO.

@sondavidb take a look at #1248 which builds on this PR to achieve that goal.

@austinvazquez austinvazquez force-pushed the add-update-getting-started-guide-automation branch 11 times, most recently from b5716b5 to 4be3bba Compare May 28, 2024 17:30
@austinvazquez
Copy link
Contributor Author

@pendo324, @sondavidb, I have added an assertion which is ran on pull request to the workflow and docs/getting-started.md to validate the update behaves correctly. Please take a look and lmk your thoughts.

pendo324
pendo324 previously approved these changes May 28, 2024
@austinvazquez austinvazquez force-pushed the add-update-getting-started-guide-automation branch 4 times, most recently from 3d06f6a to 20bec27 Compare May 28, 2024 19:29
sondavidb
sondavidb previously approved these changes May 28, 2024
Copy link
Contributor

@sondavidb sondavidb left a comment

Choose a reason for hiding this comment

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

LGTM, cool to automate another part of our release process

@austinvazquez
Copy link
Contributor Author

@sondavidb, apologies I was doing some permissions testing in another branch and somehow mixed up the changes in this branch. Added permission contents: write back to this PR.

@austinvazquez austinvazquez force-pushed the add-update-getting-started-guide-automation branch from 17d0d70 to efe36ae Compare May 29, 2024 14:30
pendo324
pendo324 previously approved these changes May 29, 2024
This change adds an automated workflow to open a pull request to update the
version in the getting started guide when a release is made.

Signed-off-by: Austin Vazquez <[email protected]>
@austinvazquez austinvazquez force-pushed the add-update-getting-started-guide-automation branch from def070e to 2207b12 Compare May 29, 2024 16:59
@austinvazquez austinvazquez merged commit 310a88e into awslabs:main May 31, 2024
14 checks passed
@austinvazquez austinvazquez deleted the add-update-getting-started-guide-automation branch May 31, 2024 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants