ci: publish documentation pages#795
Merged
Merged
Conversation
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.
Summary
.github/workflows/docs-pages.ymlto build the Doxygen reference, validate the generatedindex.html, upload a Pages artifact, and deploymasterbuilds with GitHub Pages.INFINI_RT_ROOTis available.docs/README.md,docs/build.md, anddocs/api/reference.mdto describe PR validation andmasterpublishing.Motivation
InfiniOps now has a local Doxygen target, but documentation publishing still needs CI coverage. This PR mirrors the InfiniRT documentation Pages workflow while accounting for InfiniOps' InfiniRT dependency and wrapper-generation Python dependencies.
Closes N/A - staged documentation system follow-up.
Type of Change
feat- new feature / new operator / new platformfix- bug fixperf- performance improvement (no behavioral change)refactor- code restructuring without behavior changetest- adding or fixing tests onlydocs- documentation onlybuild/ci- build system or CI configurationchore- tooling, formatting, or other non-code changes!in the Conventional Commits prefix or aBREAKING CHANGE:footer)Platforms Affected
WITH_CPU)WITH_NVIDIA)WITH_ILUVATAR)WITH_METAX)WITH_CAMBRICON)WITH_MOORE)WITH_ASCEND)WITH_TORCH)Smoke Test Result
The
deployjob is intentionally gated bygithub.event_name == 'push' && github.ref == 'refs/heads/master', so PR validation exercises the build and artifact path without publishing Pages.Test Results on Supported Platforms
Full `pytest` output (optional)
Benchmark / Performance Impact
N/A - CI and documentation publishing only.
Notes for Reviewers
The workflow deploys only on pushes to
master; pull requests build the sameinfiniops_docstarget and upload the generated HTML as a Pages artifact for validation. Repository Pages source must be configured to GitHub Actions before deployment can publish the site.