Dispatch release workflow from CI workflow #218
Merged
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
lokst
commented
Aug 21, 2025
| TAG_SHA="$(git rev-parse "$REF^{commit}")" | ||
| COMMIT_SHA="${{ github.event.workflow_run.head_sha }}" | ||
| if [ "$TAG_SHA" != "$COMMIT_SHA" ]; then | ||
| echo "Tag SHA $TAG_SHA does not match pushed commit SHA $COMMIT_SHA" |
Contributor
Author
There was a problem hiding this comment.
I tested (in another repository) that this successfully guards against the following case:
- A branch with the same name as an existing valid tag is created
- The "CI" workflow in that branch is modified to run upon a push to the branch (thus causing the CI workflow to be triggered on pushes to the branch)
lokst
commented
Aug 21, 2025
| name: Publish Client | ||
| needs: validate-tag | ||
| runs-on: ubuntu-latest | ||
| if: ${{ needs.validate-tag.outputs.valid_tag == 'true' && github.event.workflow_run.conclusion == 'success' }} |
Contributor
Author
There was a problem hiding this comment.
A test showing that the job will be skipped if the condition is not met
(Conducted in another repository)
A test showing a successful job run
A valid tag is pushed:
The tag is successfully validated:
The publish job is run:
dallasread
approved these changes
Aug 21, 2025
Member
dallasread
left a comment
dallasread
left a comment
There was a problem hiding this comment.
This looks good to me – thanks! 🥇
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 updates our workflows to dispatch
Releasefrom theCIworkflow.Currently the
Releaseworkflow is directly triggered upon a tag push but as discussed here, it relies on a third-party action to validate that the CI workflow ran successfully for the tagged commit.With the changes in this PR, we will use
workflow_runto make theReleaseworkflow run automatically when theCIworkflow completes, with the following necessary accompanying changes:CIworkflow upon a tag push that matches a valid patternvalidate-tagjob to theReleaseworkflow, that validates that theCIworkflow was triggered from a push of a valid tag, and only allows thepublishjob to run if the validation succeeds. This is necessary because theCIworkflow can be triggered by other conditions including a push tomainbranch.Addresses #201
Note: Here is a simplified version of the workflows for ease of testing in any repository: https://gist.github.com/lokst/e8ee94f6289bbc82a25b21c96e44bf2f