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 create release branch workflow #1248

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

austinvazquez
Copy link
Contributor

@austinvazquez austinvazquez commented May 23, 2024

Issue #, if available:
Follow-up to #1238

On each release, there is a manual set of steps to generate the THIRD_PARTY_LICENSES file and set the version in the getting start guide on the new release branch. It would be nice to have some automation for creating the release branch and generating the changes needed so maintainers only have to approve and merge a single pull request.

Description of changes:
This change adds a GitHub Actions workflow for creating a release branch and generating the pull request with the changes needed for THIRD_PARTY_LICENSES file and updating the getting started guide.

Testing performed:
Merged workflow to fork and ran to create release/v0.8 branch.

Ran via command like:

gh workflow run create-release-branch.yml -f major_minor_version=0.8 -f base_commit=03682f9a96919db60ba3a55ae20f5be84eec708d

GitHub Action workflow run - https://github.com/austinvazquez/soci-snapshotter/actions/runs/9334082659
PR for adding THIRD_PARTY_LICENSES and updating getting started guide - austinvazquez#40

Alternatives considered:

  1. A variation where the changes are committed and pushed by automation instead of creating a pull request. This approach does not give maintainers a manual gate for approving the changes.

Limitations:

  1. Similar to other workflows which create pull requests, the PR must be manually 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-create-release-branch-automation branch 3 times, most recently from cbbe038 to e8d203d Compare May 23, 2024 16:44
@austinvazquez austinvazquez force-pushed the add-create-release-branch-automation branch 11 times, most recently from d5bdda5 to a82d775 Compare June 1, 2024 16:16
@austinvazquez austinvazquez force-pushed the add-create-release-branch-automation branch 2 times, most recently from 1f10ddd to 1b6a6c1 Compare June 2, 2024 00:04
@austinvazquez austinvazquez marked this pull request as ready for review June 2, 2024 00:11
@austinvazquez austinvazquez requested a review from a team as a code owner June 2, 2024 00:11
@austinvazquez austinvazquez added the github_actions Pull requests that update GitHub Actions code label Jun 4, 2024
This change adds a GitHub Actions workflow for creating release branches
with jobs to 1) create the branch and 2) open a pull request with the
generated THIRD_PARTY_LICENSES file and updated getting started guide
version.

Signed-off-by: Austin Vazquez <[email protected]>
@austinvazquez austinvazquez force-pushed the add-create-release-branch-automation branch from 1b6a6c1 to 916aae9 Compare August 27, 2024 15:26
Copy link
Contributor

@pendo324 pendo324 left a comment

Choose a reason for hiding this comment

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

Nice, LGTM.

Very minor nit: you probably don't need to explicitly run the helper scripts with bash in the workflow steps (can replace with ./), since you're already using a #! in all of the scripts

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants