Skip to content

Update versions1.json as part of version bump - #1004

Merged
rapids-bot[bot] merged 1 commit into
NVIDIA:mainfrom
AyodeAwe:fix/add-versions1-to-update-version-sh
Mar 31, 2026
Merged

Update versions1.json as part of version bump#1004
rapids-bot[bot] merged 1 commit into
NVIDIA:mainfrom
AyodeAwe:fix/add-versions1-to-update-version-sh

Conversation

@AyodeAwe

Copy link
Copy Markdown
Contributor

update-version.sh updates VERSION and all associated files, but docs/cuopt/source/versions1.json was not included. This caused the pre-commit style check to fail on main after the 26.04 burndown version bump -- versions1.json still referenced 26.04.00 while VERSION had moved to 26.06.00.

This adds a call to ci/utils/update_doc_versions.py at the end of update-version.sh so the docs version switcher is updated atomically as part of every version bump, rather than relying on the pre-commit hook to catch the gap after the fact.

@AyodeAwe
AyodeAwe requested a review from a team as a code owner March 31, 2026 14:02
@AyodeAwe
AyodeAwe requested a review from vyasr March 31, 2026 14:02
@AyodeAwe AyodeAwe added non-breaking Introduces a non-breaking change improvement Improves an existing functionality labels Mar 31, 2026
@coderabbitai

coderabbitai Bot commented Mar 31, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

A post-processing step was added to the version update release script that invokes a Python utility for updating documentation versions. The invocation occurs after existing documentation link replacements. No other version-update logic or control flow was modified.

Changes

Cohort / File(s) Summary
Release Version Update Script
ci/release/update-version.sh
Added post-processing step invoking python ci/utils/update_doc_versions.py after context-dependent documentation link replacements.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding versions1.json to the version bump process as part of update-version.sh.
Description check ✅ Passed The description is directly related to the changeset, explaining the context (missing versions1.json updates), the problem (pre-commit failures), and the solution (calling update_doc_versions.py).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
ci/release/update-version.sh (1)

155-157: Consider adding error handling to ensure partial failures are caught.

The approach is correct—placing this after VERSION is written ensures the Python script reads the updated version. However, if update_doc_versions.py fails (e.g., missing file, JSON parse error), the bash script will still exit successfully, potentially leaving the repository in an inconsistent state (the same class of problem this PR aims to fix).

🛡️ Suggested fix to propagate errors
 # Update docs version switcher to include the new version
-python ci/utils/update_doc_versions.py
+if ! python ci/utils/update_doc_versions.py; then
+    echo "Error: Failed to update docs version switcher"
+    exit 1
+fi
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@ci/release/update-version.sh` around lines 155 - 157, The call to python
ci/utils/update_doc_versions.py in update-version.sh can fail silently; ensure
failures propagate so the release script exits non-zero: after invoking the
script (or at the top of update-version.sh), enable exit-on-error (e.g., set -e
/ set -o errexit) or check the python command's exit status and echo an error
then exit 1 on failure; update references to update_doc_versions.py and the
python invocation so any exception (missing file, parse error) aborts the
release process rather than allowing a partial/incorrect state.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@ci/release/update-version.sh`:
- Around line 155-157: The call to python ci/utils/update_doc_versions.py in
update-version.sh can fail silently; ensure failures propagate so the release
script exits non-zero: after invoking the script (or at the top of
update-version.sh), enable exit-on-error (e.g., set -e / set -o errexit) or
check the python command's exit status and echo an error then exit 1 on failure;
update references to update_doc_versions.py and the python invocation so any
exception (missing file, parse error) aborts the release process rather than
allowing a partial/incorrect state.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 109687a8-14e3-4921-bf4a-d6a152435f8e

📥 Commits

Reviewing files that changed from the base of the PR and between d03e197 and 66ea6d7.

📒 Files selected for processing (1)
  • ci/release/update-version.sh

@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator

/merge

@rapids-bot
rapids-bot Bot merged commit 2cf8b32 into NVIDIA:main Mar 31, 2026
76 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improves an existing functionality non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants