Skip to content

feat: publish durable documentation downloads - #8

Merged
zackees merged 1 commit into
mainfrom
feat/publication-bundle
Oct 22, 2026
Merged

zackees merged 1 commit into
mainfrom
feat/publication-bundle

Conversation

@zackees

@zackees zackees commented Oct 22, 2026 •

Copy link
Copy Markdown
Member

Changes

  • Package each exact-tag documentation publication as a checksummed versioned GitHub release download.
  • Publish a public publication.json manifest containing generation, source release metadata, archive URL, size and SHA-256.
  • Include matching generation in archive release.json; select the new download through Pages only after successful deployment.
  • Leave unchanged-release checks and the exact-tag build guard intact. Generated HTML and archives stay outside Git.

Verification

  • Five new real-archive tests; all 18 dox tests pass.
  • Cross-repository integration using the actual producer and website importer passes.
  • Ruff, Actionlint, whitespace checks and the single primary review pass.
  • Full hosted build/download/website verification follows merge.

Coordinated with FastLED/fastled-fastled.github.io#9. This producer must land before the website importer.

Website consumer: FastLED/fastled-fastled.github.io#10.

@coderabbitai

coderabbitai Bot commented Oct 22, 2026

Copy link
Copy Markdown

Review in Change Stack →

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: ac8dd9c1-e4d8-4cea-8282-75cfaf3c2921
📥 Commits

Reviewing files that changed from the base of the PR and between 43aefac and ef0d385.

📒 Files selected for processing: 5
  • .github/workflows/doxygen.yml
  • .gitignore
  • README.md
  • scripts/package_docs.py
  • scripts/test_package_docs.py
+--------------------------------------------------------------------------------------------------------------------------+
| Unix was not designed to stop its users from doing stupid things, as that would also stop them from doing clever things. |
+--------------------------------------------------------------------------------------------------------------------------+
  \
   \     /)/)
        ( '')
        /  |
      o(___)
✨ Finishing Touches
📝 Generate docstrings
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@zackees
zackees merged commit 42a4ffe into main Oct 22, 2026
1 check was pending
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.

1 participant