ci: enable automatic GitVersion tag creation on main - #88
Merged
Conversation
When CI runs on main after merge, create and push the git tag based on GitVersion-determined semver. This enables v1.0.1, v1.0.2, etc. to be automatically tagged without manual intervention. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
🏗️ PR Added to Squad Triage QueueThis PR has been labeled with Next steps:
|
github-actions
Bot
added
the
squad
Contributor
|
Contributor
SummarySummary
CoverageAppHost - 0%
Domain - 87.2%
ServiceDefaults - 0%
Web - 68.7%
|
There was a problem hiding this comment.
Pull request overview
Adds automatic git tag creation to the existing CI workflow so pushes to main can produce a v{semver} tag derived from GitVersion, enabling a release flow based on tags.
Changes:
- Add a CI step that tags the current commit on
mainwithv${{ steps.gitversion.outputs.semVer }}. - Push the created tag back to
originfrom CI.
Comment on lines
+150
to
+152
| echo "Creating tag: $TAG" | ||
| git tag "$TAG" || echo "Tag already exists: $TAG" | ||
| git push origin "$TAG" || echo "Tag already pushed" |
There was a problem hiding this comment.
The || echo ... fallbacks on git tag/git push will mask real failures (e.g., permission issues, remote rejection because the tag already exists, or trying to push a tag that wasn't created locally). This can make the workflow appear successful even when no tag was pushed. Prefer explicit existence checks (local+remote) and only treat "already exists" as success; otherwise fail the step so release automation doesn't silently break.
Suggested change
| echo "Creating tag: $TAG" | |
| git tag "$TAG" || echo "Tag already exists: $TAG" | |
| git push origin "$TAG" || echo "Tag already pushed" | |
| echo "Ensuring tag exists locally and remotely: $TAG" | |
| if git rev-parse -q --verify "refs/tags/$TAG" >/dev/null; then | |
| echo "Tag already exists locally: $TAG" | |
| else | |
| echo "Creating local tag: $TAG" | |
| git tag "$TAG" | |
| fi | |
| if git ls-remote --tags origin "refs/tags/$TAG" | grep -q "refs/tags/$TAG$"; then | |
| echo "Tag already exists on remote: $TAG" | |
| else | |
| echo "Pushing tag to remote: $TAG" | |
| git push origin "$TAG" | |
| fi |
Comment on lines
+144
to
+152
| - name: Create and Push Git Tag | ||
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| run: | | ||
| TAG="v${{ steps.gitversion.outputs.semVer }}" | ||
| echo "Creating tag: $TAG" | ||
| git tag "$TAG" || echo "Tag already exists: $TAG" | ||
| git push origin "$TAG" || echo "Tag already pushed" |
There was a problem hiding this comment.
This step attempts to git push origin "$TAG", but the job's workflow token permissions are currently contents: read (see job-level permissions earlier in this file). With read-only contents permissions, pushing tags will be rejected. Update the workflow/job permissions to contents: write (or move tagging into a separate job with elevated permissions) so the tag push can succeed.
Comment on lines
+145
to
+149
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| run: | | ||
| TAG="v${{ steps.gitversion.outputs.semVer }}" |
There was a problem hiding this comment.
TAG="v${{ steps.gitversion.outputs.semVer }}" relies on the gitversion step outputs, but the GitVersion setup/execute steps are configured with continue-on-error: true. If GitVersion fails, semVer can be empty and this step would create/push an invalid tag like v. Add a guard (e.g., require steps.gitversion.outcome == 'success' and a non-empty semVer) or fail the job when GitVersion can't determine a version on main.
Suggested change
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| TAG="v${{ steps.gitversion.outputs.semVer }}" | |
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' && steps.gitversion.outcome == 'success' && steps.gitversion.outputs.semVer != '' | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| SEMVER="${{ steps.gitversion.outputs.semVer }}" | |
| if [ -z "$SEMVER" ]; then | |
| echo "GitVersion did not produce a semVer output; refusing to create a tag." | |
| exit 1 | |
| fi | |
| TAG="v$SEMVER" |
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
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.
Add step to CI workflow that creates and pushes git tags for each commit to main, using GitVersion-determined semver.
This completes the v1.0.1 release flow:
Closes: versioning automation setup