Repository navigation
ci(docs): deploy the site through the shared mkdocs pages workflow - #58
Merged
Merged
Conversation
The repository's Pages source is "GitHub Actions", which ignores the gh-pages branch that the deploy job pushed to with peaceiris. Docs runs succeeded, but nothing they built reached the live site. docs.yml now only calls the organisation's reusable workflow THD-Spatial-AI/.github mkdocs-pages.yml@v1. It lints the OpenAPI spec with Redocly, builds with mkdocs --strict and publishes through actions/deploy-pages. It triggers on docs/** and mkdocs.yml, which are the only inputs MkDocs reads, and can be run manually through workflow_dispatch. The workflow needs contents: read only. The arc42 PDF build moves unchanged into its own arc42.yml, triggered on documentation/**. The PDF stays a run artifact and is not published. The strict build and the Redocly 2.51.2 lint both pass on the current docs.
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.
Pages for this repository is set to "GitHub Actions", which ignores the
gh-pagesbranch the old deploy job pushed to with peaceiris. Docs runs succeeded, but the live site stopped updating after 2026-09-29: for example, the landing page does not show the "2,124 of 2,147" validation figure from #56.Changes:
docs.ymlnow only callsTHD-Spatial-AI/.github/.github/workflows/mkdocs-pages.yml@v1. That workflow lints the OpenAPI spec with Redocly 2.51.2, builds withmkdocs build --strict, and publishes withactions/deploy-pages.docs.ymltriggers ondocs/**andmkdocs.yml, and gainsworkflow_dispatchfor manual runs. Its permission drops fromcontents: writetocontents: read.build-arc42job moves unchanged into a newarc42.yml, triggered ondocumentation/**. The PDF stays a run artifact and is not published.Checks run locally:
mkdocs build --strictpasses with no warnings.npx @redocly/cli@2.51.2 lint docs/openapi/openapi.yamlpasses with 4 warnings, the same result as before.The
gh-pagesbranch is left in place.