Check for version tag instead of event type in docs workflow#32
Merged
theroyalwhee0 merged 1 commit intomainfrom Nov 4, 2025
Conversation
Change docs workflow to check if the current commit has a v* tag instead of checking the event type. This allows: - Manual workflow runs on tagged commits to generate versioned docs - More flexible documentation generation regardless of trigger method - Rebuilding docs for a specific version by running workflow on that tag **Changes:** - Replace event type check with tag detection using git tag --points-at HEAD - Add fetch-depth: 0 to checkout to ensure all tags are available - Remove index.html generation (managed directly in gh-pages branch) Resolves #31
theroyalwhee0
deleted the
31-docs-workflow-should-check-for-version-tag-instead-of-event-type
branch
theroyalwhee0
added a commit
that referenced
this pull request
Nov 4, 2025
Add '|| true' to grep command to prevent exit code 1 from causing workflow failure when no version tags are found on the commit. This fixes the docs workflow failure introduced in #32.
theroyalwhee0
added a commit
that referenced
this pull request
Nov 4, 2025
Add '|| true' to grep command to prevent exit code 1 from causing workflow failure when no version tags are found on the commit. This fixes the docs workflow failure introduced in #32.
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
1 participant
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.
Summary
Updates the docs workflow to check if the current commit has a
v*tag instead of checking the GitHub event type. This provides more flexibility for documentation generation.Changes
Tag Detection:
github.event_namecheck withgit tag --points-at HEADis_release=trueif any v* tags found on current commitFetch Depth:
fetch-depth: 0to checkout step to ensure all tags are availableIndex Page:
Benefits
Test Plan
Resolves #31