docs: add changelog - #3637
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
WalkthroughThe documentation now publishes dated release entries under a unified changelog, updates navigation and redirects for the v2.0 documentation site, removes the legacy release-notes page, revises related references, and expands documentation preview collection. ChangesChangelog publication migration
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
/ok to test |
🔍 Container Scan Summary
Per-CVE detail lives in the per-service |
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3637.docs.buildwithfern.com/infra-controller Here are the markdown pages you've updated: |
🔐 TruffleHog Secret Scan✅ No secrets or credentials found! Your code has been scanned for 700+ types of secrets and credentials. All clear! 🎉 🕐 Last updated: 2026-07-17 01:30:26 UTC | Commit: 36d2643 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@fern/changelog/2026-07-31.mdx`:
- Around line 39-44: Update the v0.8 upgrade steps to explicitly document the
--skip-rest cutover gate: run ./setup.sh --skip-rest to provision prerequisites
and External Secrets, quiesce REST writes, restore nico_rest, then rerun
./setup.sh without --skip-rest so the REST chart and migration job start only
after restoration.
- Around line 1-7: Remove or defer the 2026-07-31 changelog entry so it is not
present in fern until the release date; keep the NVIDIA Infra Controller v2.0
content unchanged when it is reintroduced for publication.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 956d2c58-ea5d-407d-9277-26c956d38b0e
📒 Files selected for processing (12)
docs/.rumdl.tomldocs/development/release_and_qa_process.mddocs/index.mddocs/index.ymldocs/release-notes.mdfern/changelog/2026-01-23.mdxfern/changelog/2026-02-12.mdxfern/changelog/2026-05-15.mdxfern/changelog/2026-07-31.mdxfern/changelog/overview.mdxfern/docs.ymlrest-api/CHANGELOG.md
💤 Files with no reviewable changes (1)
- docs/release-notes.md
| To upgrade from v0.8: | ||
|
|
||
| 1. Back up the REST database from the standalone PostgreSQL pod. | ||
| 2. Run `setup.sh` to provision the shared database and External Secrets synchronization. | ||
| 3. Restore the backup into `nico_rest` on `nico-pg-cluster` when existing REST state must be retained. | ||
| 4. Confirm that `nico-rest-pg-creds` exists in the `nico-rest` namespace before starting the REST database migration job. |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Locate the referenced changelog and related operational docs.
git ls-files 'fern/changelog/2026-07-31.mdx' 'fern/**' 'README.md' | sed -n '1,200p'
# Map the changelog file structure first.
ast-grep outline fern/changelog/2026-07-31.mdx --view expanded || true
# Read the relevant section with line numbers.
sed -n '1,140p' fern/changelog/2026-07-31.mdx | cat -n
# Search for the named resources and cutover-related guidance across fern docs.
rg -n --hidden --glob 'fern/**' --glob '!**/.git/**' \
'setup\.sh|nico-rest-pg-creds|nico_rest|External Secrets|migration job|quiescence|cutover|restore the backup|shared database' \
fern || trueRepository: NVIDIA/infra-controller
Length of output: 5413
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Search the repo for REST cutover, migration, and quiescence guidance.
rg -n --hidden --glob '!**/.git/**' \
'quiescence|quiesce|cutover|migration job|nico-rest-pg-creds|nico_rest|rest.enabled|setup\.sh|standalone REST PostgreSQL|External Secrets Operator|External Secrets' \
. || true
# Inspect the changelog around the REST consolidation section for exact wording.
sed -n '31,46p' fern/changelog/2026-07-31.mdx | cat -nRepository: NVIDIA/infra-controller
Length of output: 44699
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Inspect the REST-related sequencing inside setup.sh.
sed -n '730,790p' helm-prereqs/setup.sh | cat -n
sed -n '1010,1060p' helm-prereqs/setup.sh | cat -n
# Inspect the REST chart notes and migration-job tests for hook timing.
sed -n '1,120p' helm/charts/nico-api/tests/migration_job_test.yaml | cat -n
sed -n '1,120p' helm/templates/NOTES.txt | cat -n
# Inspect the REST chart docs for whether migrations are automatic/pre-install.
sed -n '1,120p' rest-api/CHANGELOG.md | cat -n
sed -n '1,120p' helm/rest/README.md | cat -nRepository: NVIDIA/infra-controller
Length of output: 28629
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Inspect setup.sh option parsing and phase gating for --skip-rest.
sed -n '1,140p' helm-prereqs/setup.sh | cat -n
sed -n '140,260p' helm-prereqs/setup.sh | cat -n
sed -n '260,360p' helm-prereqs/setup.sh | cat -n
# Look for the actual conditional around the REST phase.
rg -n --hidden --glob '!**/.git/**' 'skip-rest|Phase 7g|NICo REST helm chart|REST helm chart|skip_rest' helm-prereqs/setup.shRepository: NVIDIA/infra-controller
Length of output: 21667
Call out the --skip-rest cutover gate.
Document the safe upgrade path explicitly: run ./setup.sh --skip-rest to provision prereqs and ESO, quiesce REST writes, restore nico_rest, then rerun ./setup.sh without --skip-rest so the REST chart and migration job start only after the restore.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@fern/changelog/2026-07-31.mdx` around lines 39 - 44, Update the v0.8 upgrade
steps to explicitly document the --skip-rest cutover gate: run ./setup.sh
--skip-rest to provision prerequisites and External Secrets, quiesce REST
writes, restore nico_rest, then rerun ./setup.sh without --skip-rest so the REST
chart and migration job start only after restoration.
Source: Path instructions
|
/ok to test |
|
Looks fine to me, are we planning on the GitHub release description (i.e. the native GitHub release) to link to the Fern docs? Also I assume that the content for v2.0 isn't ready yet, because we shipped way more stuff than NTP containers :) |
We should link each to the other, yes.
You assume correctly! I'm going to back that out, actually, and replace it with a "forthcoming" note. I wanted to have something in there to look at, and this was easier than Lorem Ipsum! |
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
…and REST DB consolidation (#1) Co-authored-by: Alex Ball <aball@nvidia.com> Signed-off-by: Shayan Namaghi <snamaghi@nvidia.com>
c139595 to
b2f6d7d
Compare
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
Signed-off-by: Alex Ball <aball@nvidia.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/fern-docs-preview-build.yml:
- Line 67: Update the changed-markdown discovery command in the workflow to stop
interpolating github.base_ref directly in the shell; expose it through the
step’s env configuration and reference the resulting quoted shell variable,
following the existing DEFAULT_BRANCH pattern. Preserve the current git diff
behavior and error handling.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 5ea6e57e-40c1-45d3-92b0-cc57ab6382bb
📒 Files selected for processing (1)
.github/workflows/fern-docs-preview-build.yml
| echo "${{ github.event.pull_request.number }}" > preview-metadata/pr_number | ||
| echo "${{ github.head_ref }}" > preview-metadata/head_ref | ||
| git diff --name-only "origin/${{ github.base_ref }}...HEAD" -- '*.md' > preview-metadata/changed_md_files 2>/dev/null || true | ||
| git diff --name-only "origin/${{ github.base_ref }}...HEAD" -- '*.md' '*.mdx' > preview-metadata/changed_md_files 2>/dev/null || true |
There was a problem hiding this comment.
🔒 Security & Privacy | 🟠 Major | ⚡ Quick win
Do not interpolate github.base_ref directly into the shell.
The expression is expanded before Bash parses the run block, so a ref containing shell metacharacters can break out of the quoted argument and execute commands on the runner. Pass github.base_ref through env and reference the resulting shell variable, as already done for DEFAULT_BRANCH.
As per path instructions, this workflow must be reviewed for trigger correctness and security handling.
🧰 Tools
🪛 zizmor (1.26.1)
[error] 67-67: code injection via template expansion (template-injection): may expand into attacker-controllable code
(template-injection)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In @.github/workflows/fern-docs-preview-build.yml at line 67, Update the
changed-markdown discovery command in the workflow to stop interpolating
github.base_ref directly in the shell; expose it through the step’s env
configuration and reference the resulting quoted shell variable, following the
existing DEFAULT_BRANCH pattern. Preserve the current git diff behavior and
error handling.
Sources: Path instructions, Linters/SAST tools
|
/ok to test |
4 participants
This change replaces the release notes with a changelog.
👉 The link for the release notes is now in the left nav, directly below Home.
For more information on the approach, refer to Fern's documentation on changelogs is here, and have a look at their own changelog.
This brings some advantages over a monolithic file, particularly if we're going to continue on a monthly release cadence:
Note: Adding some MDX files exposed a couple of small issues in the Fern preview pipeline. Adding that fix has triggered a required review from the CI/CD maintainers.
Type of Change
Breaking Changes
Testing