fix(docs): publish release docs from release workflow#140
fix(docs): publish release docs from release workflow#140lipikaramaswamy wants to merge 1 commit intomainfrom
Conversation
Ensure main docs deploys only the dev version while release runs publish the versioned docs and latest alias. Signed-off-by: lipikaramaswamy <lramaswamy@nvidia.com>
Greptile SummaryThis PR fixes docs aliasing so
Confidence Score: 3/5Not safe to merge until the missing notebook-artifact step is addressed in the new release docs job. A P1 finding — the new deploy job silently deploys incomplete docs missing notebook content — pulls the score below the P1 ceiling of 4. .github/workflows/release.yml — the new Important Files Changed
Sequence DiagramsequenceDiagram
participant D as workflow_dispatch
participant RW as release.yml
participant DW as docs.yml
participant GHP as gh-pages
D->>RW: trigger (release-ref, create-gh-release=true)
RW->>RW: publish-wheel (build + upload to PyPI)
RW->>RW: create-gh-release (gh release create via GITHUB_TOKEN)
Note over DW: release event NOT fired
RW->>RW: deploy-release-docs checkout → setup-python → docs-build
Note over RW: No build-notebooks or artifact download
RW->>GHP: mike deploy VERSION latest
Note over DW: On push to main:
DW->>DW: checkout → setup-python → docs-build
DW->>GHP: mike deploy dev
Note over DW: On manual GitHub release:
DW->>DW: build-notebooks
DW->>DW: deploy-release (download notebooks → docs-build)
DW->>GHP: mike deploy VERSION latest
Reviews (1): Last reviewed commit: "fix(docs): publish release docs from rel..." | Re-trigger Greptile |
| deploy-release-docs: | ||
| name: Deploy release docs | ||
| needs: [publish-wheel, create-gh-release] | ||
| if: ${{ inputs.create-gh-release }} | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| steps: | ||
| - name: Checkout at release ref | ||
| uses: actions/checkout@v6 | ||
| with: | ||
| ref: ${{ inputs.release-ref }} | ||
| fetch-depth: 0 | ||
|
|
||
| - uses: ./.github/actions/setup-python-env | ||
| with: | ||
| ref: ${{ inputs.release-ref }} | ||
| fetch-depth: "0" | ||
|
|
||
| - name: Install docs dependencies | ||
| run: uv sync --group dev --group docs | ||
|
|
||
| - name: Configure git for mike | ||
| run: | | ||
| git config user.name "github-actions[bot]" | ||
| git config user.email "github-actions[bot]@users.noreply.github.com" | ||
|
|
||
| - name: Build docs | ||
| run: make docs-build | ||
|
|
||
| - name: Deploy release docs with mike | ||
| env: | ||
| VERSION: ${{ needs.publish-wheel.outputs.version }} | ||
| run: uv run --group docs mike deploy --push --update-aliases "$VERSION" latest |
There was a problem hiding this comment.
Missing notebook artifacts in release docs deployment
The new deploy-release-docs job skips the build-notebooks step and never downloads pre-built notebook artifacts into docs/notebooks/ before running make docs-build. The equivalent deploy-release job in docs.yml (lines 68–103) depends on build-notebooks and explicitly downloads those artifacts via actions/download-artifact. Docs deployed through this path will therefore be missing any notebook-derived content that the release docs in docs.yml would have included.
Summary
latestpointed at the newest released docs instead ofdevType of Change
Testing
make testpasses locallymake checkpasses locally (format + lint + typecheck + lock-check)Documentation
make docs-buildpasses locally