NVIDIA / NVIDIA/nvcf

Automate reviewable development docs sync PRs after stack releases

Open
#1,845 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
218
Forks
72
Avg merge
1d 9h
Merged PRs (30d)
417

Description

Problem

Each stack release publishes an owned inventory, but updating the development
version catalog still requires a maintainer to run
docs-version-sync --update-catalog and open a Pull Request manually.

Top-of-tree documentation can drift after stack releases even when all three
inventory assets are available.

Desired behavior

After stack inventories are published, automation opens or updates one
reviewable development documentation Pull Request. QA qualification and stable
documentation cuts remain explicit maintainer actions.

Scope

  • Trigger after a stack inventory release, with a manual retry option.
  • Wait until complete inventory assets are available for all three stacks.
  • Coalesce closely timed stack releases into one development update.
  • Run the catalog update, generated documentation update, and offline checks.
  • Open or update one bot-owned Pull Request with the exact three stack versions.
  • Keep synchronization failures advisory during the initial rollout.

Acceptance criteria

  • A completed three-stack release set creates or updates one reviewable Pull
    Request.
  • The Pull Request records the selected control-plane, compute-plane, and
    observability versions.
  • No Pull Request is opened when generated content is unchanged.
  • Repeated runs are idempotent and reuse the existing automation branch.
  • A missing or invalid inventory produces an actionable warning and does not
    modify stable documentation.
  • The workflow never qualifies a release set or cuts versioned documentation.
  • Logs and generated changes contain no credentials or private registry data.

References

  • Relates to #1838
  • Follow-up to #1839

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the stack inventory publication flow and the docs-version-sync --update-catalog entry point; the issue names no files or tests. Trace how the three inventory assets and generated documentation checks are currently run, then verify that the resulting automation meets the acceptance criteria without qualifying releases or changing stable documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
ci-cd, documentation, release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.