Update release workflow to use PR-based approach #46
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Modified release.yml to create a version bump PR instead of direct commit - Created auto-release.yml to automatically create release when PR is merged - Workflow now respects branch protection rules
The validation 'failures' on push are harmless - they're just GitHub validating the YAML syntax. Since the workflow only has workflow_dispatch trigger, it won't actually run on push.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request updates the release workflow to use a PR-based approach, ensuring compliance with branch protection rules without requiring bypass permissions
Two-Step Release Process
The release workflow has been split into two automated workflows:
Step 1: Create Version Bump PR (release.yml)
Manually triggered workflow that validates the version format, runs tests and linting, updates
SDKVersion.swift, and creates a PR to main with thereleaselabel. The PR includes a changelog preview generated from GitHub's release notes API, showing all merged PRs since the last tagStep 2: Auto Release (auto-release.yml)
Triggers automatically when a PR with the "release" label is merged to main. Extracts the version from the PR title, verifies it matches
SDKVersion.swift, creates and pushes the git tag, and generates the GitHub release with auto-generated notesUsage
Trigger the workflow from the terminal:
Once the PR is created and merged, the release is automatically generated