Skip to content

fix(docs): publish release docs from release workflow#140

Open
lipikaramaswamy wants to merge 1 commit intomainfrom
fix/release-docs-deploy
Open

fix(docs): publish release docs from release workflow#140
lipikaramaswamy wants to merge 1 commit intomainfrom
fix/release-docs-deploy

Conversation

@lipikaramaswamy
Copy link
Copy Markdown
Collaborator

Summary

  • Keep latest pointed at the newest released docs instead of dev
  • Deploy release docs from the release workflow so Actions-created releases publish versioned docs reliably

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Refactoring

Testing

  • make test passes locally
  • make check passes locally (format + lint + typecheck + lock-check)
  • Added/updated tests for changes

Documentation

  • If docs changed: make docs-build passes locally

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>
@lipikaramaswamy lipikaramaswamy requested a review from a team as a code owner April 28, 2026 19:15
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Apr 28, 2026

Greptile Summary

This PR fixes docs aliasing so latest is only updated on actual releases (not every push to main), and adds a deploy-release-docs job in release.yml to ensure docs are deployed when the release workflow creates a GitHub release via GITHUB_TOKEN (which would not trigger the release event in docs.yml).

  • The new deploy-release-docs job does not invoke build-notebooks or download notebook artifacts before make docs-build, while the existing deploy-release job in docs.yml depends on build-notebooks and downloads those artifacts to docs/notebooks/. Docs published through this new path will be missing any notebook-derived content.

Confidence Score: 3/5

Not 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 deploy-release-docs job needs a build-notebooks dependency and artifact download step.

Important Files Changed

Filename Overview
.github/workflows/docs.yml Removes latest alias from the push-to-main deploy step so latest is only updated on releases — correct intent, low risk change.
.github/workflows/release.yml Adds deploy-release-docs job to deploy versioned docs directly from the release workflow, but omits the build-notebooks dependency and artifact download that the equivalent docs.yml release path includes.

Sequence Diagram

sequenceDiagram
    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
Loading

Reviews (1): Last reviewed commit: "fix(docs): publish release docs from rel..." | Re-trigger Greptile

Comment on lines +136 to +169
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
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 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.

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.

2 participants