Skip to content

docs: verify rendered release identity - #49

Merged
stefan-jansen merged 7 commits into
mainfrom
fix/docs-release-identity-48
Sep 19, 2026
Merged

stefan-jansen merged 7 commits into
mainfrom
fix/docs-release-identity-48

Conversation

@stefan-jansen

@stefan-jansen stefan-jansen commented Sep 19, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • expose ml4t-library, ml4t-version, and ml4t-commit in every rendered documentation page
  • make ordinary CI and a dedicated read-only Docs workflow reject missing or mismatched identity metadata after a real strict build
  • verify both stable and versioned HTML after release deployment, while retaining the existing release.json check
  • add canonical documentation, issue, release, and license links plus the exact contributor quality gates
  • prepare version 0.1.4 so the corrected deployment can identify its exact release commit

Verification

  • uv run ruff check src/ tests/ examples/ scripts/
  • uv run ruff format --check src/ tests/ examples/ scripts/
  • uv run ty check
  • uv run pytest tests/ -q --cov-report=json:coverage.json - 421 passed
  • uv run python scripts/ci/check_coverage.py coverage.json - lines 95.49%, branches 85.36%
  • revision-identified uv run mkdocs build --strict plus local identity verification
  • uv build
  • pre-commit run --all-files
  • actionlint .github/workflows/docs.yml .github/workflows/ci.yml .github/workflows/release.yml

The dedicated Docs workflow and ordinary CI build the real site with the docs extra, then validate every rendered page. Core pytest verifies exact matching and mismatch rejection without adding optional docs dependencies to core qualification.

Closes #48

Copilot AI lite review requested due to automatic review settings September 19, 2026 14:32

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@stefan-jansen
stefan-jansen merged commit 61de79b into main Sep 19, 2026
35 checks passed
@stefan-jansen
stefan-jansen deleted the fix/docs-release-identity-48 branch September 19, 2026 15:01
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.

docs: expose and verify release identity in rendered HTML

2 participants