Skip to content

feat: add rhiza_docs.yml workflow (interrogate + mike versioned docs)#903

Closed
Copilot wants to merge 4 commits intomainfrom
copilot/add-rhiza-docs-workflow
Closed

feat: add rhiza_docs.yml workflow (interrogate + mike versioned docs)#903
Copilot wants to merge 4 commits intomainfrom
copilot/add-rhiza-docs-workflow

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 24, 2026

Summary

Adds a dedicated rhiza_docs.yml workflow that enforces docstring coverage via interrogate on every push/PR and deploys versioned documentation via mike on v* release tags. Moves the docs-coverage job out of rhiza_ci.yml into this new focused workflow.

Changes

  • New .github/workflows/rhiza_docs.yml with two jobs:
    • docs-coverage — runs make docs-coverage (interrogate) on push/PR to main/master; job-level permissions: contents: read
    • deploy-versioned-docs — triggers on refs/tags/v*; checks out with fetch-depth: 0, syncs --group docs, runs mike deploy --push --update-aliases "$VERSION" latest then mike set-default --push latest; job-level permissions: contents: write
  • Removed docs-coverage job from rhiza_ci.yml (now owned by the dedicated docs workflow)
  • Updated .rhiza/docs/CONFIG.md and docs/ARCHITECTURE.md to document rhiza_docs.yml

Testing

  • make test passes locally
  • make fmt has been run
  • New tests added (or explain why not needed) — workflow-only change; no unit tests applicable

Checklist

  • Commit messages follow the Conventional Commits format
  • Documentation updated if behaviour changed
  • make deptry passes (no unused or missing dependencies)
Original prompt

This section details on the original issue you should resolve

<issue_title>feat: add rhiza_docs.yml workflow (interrogate + mike versioned docs)</issue_title>
<issue_description>## Background

Developed in tschm/jquantstats and ready to be pulled into the rhiza template.

Changes

Job 1: docs-coverage (interrogate)

Adds a new workflow rhiza_docs.yml that enforces 100% docstring coverage on all public methods using interrogate.

  • Runs make docs-coverage on every push and PR to main/master
  • Without this, new public methods added without docstrings silently produce blank pages in the MkDocs API reference
  • Reads configuration from [tool.interrogate] in pyproject.toml

Job 2: deploy-versioned-docs (mike)

Extends the same workflow with a second job that triggers on v* release tags and deploys versioned documentation to GitHub Pages using mike.

  • Checks out with fetch-depth: 0 (required by mike)
  • Runs mike deploy --push --update-aliases "$VERSION" latest
  • Runs mike set-default --push latest
  • Uses job-level permissions: contents: write (workflow-level stays contents: read)

Notes

  • configure-git-auth action is called for private package access
  • The two jobs were developed in two separate commits (8977fe9, beb148c) but should ship together</issue_description>

Comments on the Issue (you are @copilot in this section)


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

Copilot AI changed the title [WIP] Add rhiza_docs.yml workflow for docstring coverage and versioned docs feat: add rhiza_docs.yml workflow (interrogate + mike versioned docs) Mar 24, 2026
Copilot AI requested a review from tschm March 24, 2026 07:09
tschm added 2 commits March 25, 2026 16:38
Removed the deploy-versioned-docs job from the workflow.

Signed-off-by: Thomas Schmelzer <thomas.schmelzer@gmail.com>
@tschm tschm closed this Mar 27, 2026
@tschm tschm deleted the copilot/add-rhiza-docs-workflow branch March 27, 2026 10:44
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.

feat: add rhiza_docs.yml workflow (interrogate + mike versioned docs)

3 participants