-
Notifications
You must be signed in to change notification settings - Fork 55
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
Add release automation to update getting started guide #1238
Conversation
bea278c
to
59fbc1b
Compare
19bdc44
to
e64373f
Compare
e64373f
to
4734764
Compare
4734764
to
0615443
Compare
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. |
b5716b5
to
4be3bba
Compare
@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. |
3d06f6a
to
20bec27
Compare
There was a problem hiding this 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
20bec27
to
6d871d5
Compare
@sondavidb, apologies I was doing some permissions testing in another branch and somehow mixed up the changes in this branch. Added permission |
17d0d70
to
efe36ae
Compare
efe36ae
to
def070e
Compare
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]>
def070e
to
2207b12
Compare
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:
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:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.