fix(docs): publish /graphics/api/ after failed #7 Pages deploy#8
Merged
Conversation
The #7 Deploy Pages run failed because `git describe --tags` needs tags that the default shallow Actions checkout does not fetch, so `/api/` never published. Fetch full history/tags in CI and fall back when no release tag can be resolved. Co-authored-by: Brad Barnett <bdbarnett@users.noreply.github.com>
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
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.
Summary
PR #7 added the Sourcey API reference, but the merge deploy never published it. The homepage still serves the pre-#7 site, and
https://pydevices.github.io/graphics/api/returns 404.Root cause:
Deploy Pages sitefailed on push tomain(run 29725265495) becausedocs/scripts/generate_reference.pycallsgit describe --tags --abbrev=0, and the defaultactions/checkoutshallow clone has no tags (fatal: No names found, cannot describe anything.). Deploy was skipped after that failure.Fix
fetch-depth: 0andfetch-tags: trueso CI can resolve a release linerelease_tag()fall back to the newest local tag, thenunreleased, instead of crashingverify-site.mjsto require the fuller checkout settingsmainValidation
npm ci --prefix docsnpm run check --prefix docs(136 Python entries, 61 native C functions)git describefailureunreleasedwhen describe failsAfter merge, the existing Pages workflow should deploy
_site/api/and the homepage API links will go live.