Skip to content

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

Merged
lipikaramaswamy merged 1 commit into
mainfrom
fix/release-docs-deploy
May 4, 2026
Merged

fix(docs): publish release docs from release workflow#140
lipikaramaswamy merged 1 commit into
mainfrom
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
Contributor

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 thread .github/workflows/release.yml
@lipikaramaswamy lipikaramaswamy merged commit 6448648 into main May 4, 2026
11 checks passed
@lipikaramaswamy lipikaramaswamy deleted the fix/release-docs-deploy branch May 4, 2026 17:20
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