Skip to content

ci: Fix Fern docs version publishing#949

Merged
nealvaidya merged 1 commit into
mainfrom
codex/fix-aiperf-fern-dev-docs
May 15, 2026
Merged

ci: Fix Fern docs version publishing#949
nealvaidya merged 1 commit into
mainfrom
codex/fix-aiperf-fern-dev-docs

Conversation

@nealvaidya

@nealvaidya nealvaidya commented May 15, 2026

Copy link
Copy Markdown
Contributor

Summary

  • keep the Fern release job's Latest entry shaped like the docs-website branch expects
  • quote yq selectors for display-name fields with hyphens
  • let manual no-tag workflow dispatch publish even when the dev sync has no branch changes

Root cause

The v0.7.0 release run promoted the first version entry to Latest. On AIPerf, that first entry was dev, so the published docs lost the dev version entry. The docs-website branch has been manually repaired to the Dynamo-style shape with separate Latest, dev, and stable version entries.

Validation

  • git diff --check -- .github/workflows/fern-docs.yml
  • Ruby YAML parse for .github/workflows/fern-docs.yml
  • yq simulation against the repaired docs-website version list
  • SKIP=no-commit-to-branch PRE_COMMIT_HOME=/tmp/aiperf-pre-commit-cache uv run pre-commit run --files .github/workflows/fern-docs.yml

Summary by CodeRabbit

  • Chores
    • Enhanced documentation publishing workflow to improve version tracking and deployment reliability.

Review Change Stack

Signed-off-by: Neal Vaidya <nevaidya@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented May 15, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions

Copy link
Copy Markdown

Try out this PR

Quick install:

pip install --upgrade --force-reinstall git+https://github.com/ai-dynamo/aiperf.git@b3b3974591509aae6ac251035bb2820d6d3faa73

Recommended with virtual environment (using uv):

uv venv --python 3.12 && source .venv/bin/activate
uv pip install --upgrade --force-reinstall git+https://github.com/ai-dynamo/aiperf.git@b3b3974591509aae6ac251035bb2820d6d3faa73

Last updated for commit: b3b3974Browse code

@nealvaidya nealvaidya changed the title [codex] Fix Fern docs version publishing May 15, 2026
@github-actions github-actions Bot added the ci label May 15, 2026
@coderabbitai

coderabbitai Bot commented May 15, 2026

Copy link
Copy Markdown
Contributor

Walkthrough

The workflow file is updated to make docs publishing more accessible and refine version management. The publish step can now run manually via workflow dispatch when on the main branch, and version checking logic is adjusted to use a consistent field reference with explicit Latest version metadata.

Changes

Fern Docs Workflow Updates

Layer / File(s) Summary
Publish trigger on workflow dispatch
.github/workflows/fern-docs.yml
The "Publish Docs" step's if condition is broadened to allow execution during manual workflow_dispatch when is_main is true, enabling docs publishing without requiring detected changes.
Version management and Latest entry properties
.github/workflows/fern-docs.yml
Version existence check switches to yq -e query against the quoted "display-name" field, with corresponding DEV_IDX calculation updates. The Latest version entry now explicitly sets slug: latest and availability: stable.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A workflow hops with a gentle touch,
Docs publish on dispatch—oh, not so much!
Versions dance in their YAML waltz,
With display-name queries and slug defaults.
The latest stands proud, stable and true! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately captures the main change: fixing Fern docs version publishing in CI workflows. It directly relates to the primary objectives of ensuring proper version entry handling and yq selector quoting.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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 and usage tips.

@nealvaidya nealvaidya marked this pull request as ready for review May 15, 2026 23:04
@nealvaidya nealvaidya merged commit bac953d into main May 15, 2026
18 of 25 checks passed
@nealvaidya nealvaidya deleted the codex/fix-aiperf-fern-dev-docs branch May 15, 2026 23:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2 participants