Skip to content

133 documentation is not deploying to GitHub pages - #138

Merged
devsetgo merged 3 commits into
mainfrom
133-documentation-is-not-deploying-to-github-pages
May 24, 2026
Merged

133 documentation is not deploying to GitHub pages#138
devsetgo merged 3 commits into
mainfrom
133-documentation-is-not-deploying-to-github-pages

Conversation

@devsetgo

@devsetgo devsetgo commented May 24, 2026

Copy link
Copy Markdown
Owner

Addresses the issue where the 133 documentation was not deploying to GitHub pages as expected. The changes made in this pull request include:

  1. Added a new workflow file deploy-docs.yml to handle the deployment of versioned documentation to GitHub pages.
  2. The workflow is triggered by a workflow_dispatch event and requires inputs for the documentation version label, Git reference to build docs from, and optional aliases.
  3. The workflow installs necessary dependencies, prepares documentation files, and deploys the documentation using the mike tool.
  4. Additionally, modifications were made in the pythonpublish.yml workflow to adjust permissions and steps for deploying documentation.
  5. A new workflow trigger-docs was added to trigger the documentation deployment based on release events.
  6. Other minor changes include updates to file paths in coverage.xml and report.xml.

By introducing this new workflow and making necessary adjustments, the documentation deployment process for the 133 project will be streamlined and ensure that the documentation is successfully deployed to GitHub pages.

devsetgo and others added 2 commits May 24, 2026 01:32
…aforms pattern

pythonpublish.yml was trying to do everything inline (build, publish,
deploy docs) and failing. The working pattern used in pydantic-schemaforms
separates concerns into two workflows:

pythonpublish.yml (slimmed down):
- deploy: build sdist+wheel, publish to PyPI
- trigger-docs: dispatch deploy-docs.yml after deploy succeeds,
  passing version, checkout_ref, and aliases as inputs.
  Skips dispatch gracefully on workflow_dispatch (no release tag).

deploy-docs.yml (new):
- Triggered via workflow_dispatch only (dispatched by trigger-docs)
- Checks out the specific release tag
- Installs deps, prepares docs, runs deploy_docs.py with
  --ignore-remote-status and --push
- Sets 'stable' as the default alias
- Publishes to GitHub Pages via configure-pages / upload-pages-artifact
  / deploy-pages actions

scripts/deploy_docs.py: add --branch argument forwarded to mike deploy,
allowing the workflow to explicitly target the gh-pages branch.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@devsetgo devsetgo linked an issue May 24, 2026 that may be closed by this pull request
@sonarqubecloud

Copy link
Copy Markdown

@devsetgo
devsetgo merged commit 3acded3 into main May 24, 2026
14 checks passed
@devsetgo
devsetgo deleted the 133-documentation-is-not-deploying-to-github-pages branch May 24, 2026 01:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation is not deploying to GitHub pages.

1 participant