Merge update version and fix version format bugs #286

rgsl888prabhu · 2025-08-11T16:54:56Z

Description

Merge update version which was earlier split was cuOpt and Rapids into one since we are in sync with versions now.
And also fix failure in version updates and bugs around it.

Issue

closes #262

Checklist

I am familiar with the Contributing Guidelines.
Testing
- New or existing tests cover these changes
- Added tests
- Created an issue to follow-up
- NA
Documentation
- The documentation is up to date with these changes
- Added new documentation
- NA

rgsl888prabhu · 2025-08-11T23:52:38Z

@jameslamb may I get your review on this

jameslamb

Now that cuopt and RAPIDS will have aligned versions, there is a lot of opportunity for consolidating things in this new update-version.sh script. I left some specific examples I saw where things should be grouped into a smaller set of updates.

That'll make it run a little faster, reduce the risk of inconsistencies, and reduce the effort to maintain this.

Please also test this. Something like this:

./ci/release/update-version.sh '25.12.00'

# does the diff look like what you'd expect?
git diff

# did it catch everything?
git grep -E '24\.|25\.'

ci/release/update-version.sh

rgsl888prabhu · 2025-08-13T23:54:57Z

wanted to keep them separate in case if we need to be out of sync in future, but I think it can be done quite easily, will update PR as per your review

jameslamb

Thanks for the updates. I've left some more suggestions.

ci/release/update-version.sh

rgsl888prabhu · 2025-08-19T15:47:43Z

@jameslamb May I get your review on this ?

jameslamb

Approving this so you can keep moving forward. But if you haven't already, please do test it one more time, in the way I described in #286 (review)

I also think you should write up a follow-up issue about consolidating the references to versions in this project. I left a couple of suggestions, but overall there are very very many hard-coded 25.10 around the source code that all need to be kept in sync.

For inspiration, you could look at some of the PRs @KyleFromNVIDIA put up around RAPIDS implementing similar things to what I've suggested here: rapidsai/build-planning#15

jameslamb · 2025-08-19T20:56:45Z

ci/release/update-version.sh

+# Server version update
+sed_runner 's/'"\"version\": \"[0-9][0-9].[0-9][0-9]\""'/'"\"version\": \"${NEXT_SHORT_TAG}\""'/g' python/cuopt_server/cuopt_server/utils/data_definition.py
+sed_runner 's/'"\"client_version\": \"[0-9][0-9].[0-9][0-9]\""'/'"\"client_version\": \"${NEXT_SHORT_TAG}\""'/g' python/cuopt_server/cuopt_server/utils/routing/data_definition.py
+sed_runner 's/'"\"client_version\": \"[0-9][0-9].[0-9][0-9]\""'/'"\"client_version\": \"${NEXT_SHORT_TAG}\""'/g' python/cuopt_server/cuopt_server/utils/linear_programming/data_definition.py


I think it would be good to calculate this programmatically, in Python code instead.

e.g.

cuopt/python/cuopt_server/cuopt_server/utils/routing/data_definition.py

Line 1029 in b567ed4

"client_version": "25.10",

Should rely on this constant:

cuopt/python/cuopt_server/cuopt_server/_version.py

Line 18 in b567ed4

__version__ = (

Same advice goes for all 3 of these lines.

jameslamb · 2025-08-19T20:57:44Z

ci/release/update-version.sh

+sed_runner 's/'"\"client_version\": \"[0-9][0-9].[0-9][0-9]\""'/'"\"client_version\": \"${NEXT_SHORT_TAG}\""'/g' python/cuopt_server/cuopt_server/utils/linear_programming/data_definition.py
+
+# Doc update
+sed_runner 's/'"version = \"[0-9][0-9].[0-9][0-9]\""'/'"version = \"${NEXT_SHORT_TAG}\""'/g' docs/cuopt/source/conf.py


This should use cuopt.__version__ instead.

Example of how cudf does this: https://github.com/rapidsai/cudf/blob/21b69cf8c31c42bf981c5c8987b4d0d6ff36b3d5/docs/cudf/source/conf.py#L189-L195

jameslamb · 2025-08-19T20:58:46Z

ci/release/update-version.sh

+
+# Doc update
+sed_runner 's/'"version = \"[0-9][0-9].[0-9][0-9]\""'/'"version = \"${NEXT_SHORT_TAG}\""'/g' docs/cuopt/source/conf.py
+sed_runner 's/'"PROJECT_NUMBER         = [0-9][0-9].[0-9][0-9]"'/'"PROJECT_NUMBER         = ${NEXT_SHORT_TAG}"'/g' cpp/doxygen/Doxyfile


Doxyfiles can be templated and filled in at runtime with environment variables. This project should consider doing that.

Example from raft:

https://github.com/rapidsai/raft/blob/e6efdd1143c988a366619965bcdd891a4474ea7e/cpp/doxygen/Doxyfile#L41

https://github.com/rapidsai/raft/blob/e6efdd1143c988a366619965bcdd891a4474ea7e/ci/build_docs.sh#L13

jameslamb · 2025-08-19T21:01:59Z

ci/release/update-version.sh

+# Update VERSIONS.json
+VERSIONS_FILE="docs/cuopt/source/versions1.json"
+# Only update if NEXT_FULL_TAG is not already present
+if ! grep -q "\"version\": \"${NEXT_FULL_TAG}\"" "${VERSIONS_FILE}"; then
+  # Remove preferred and latest flags, but keep the version entry and URL
+  sed_runner '/"name": "latest",/d' "${VERSIONS_FILE}"
+  sed_runner '/"preferred": true,\?/d' "${VERSIONS_FILE}"
+  # Remove trailing comma after "url": ... in all version entries
+  sed_runner 's/\("url": "[^"]*"\),/\1/' "${VERSIONS_FILE}"
+  # Add new version entry with both preferred and latest flags
+  NEW_VERSION_ENTRY='    {\n      "version": "'${NEXT_FULL_TAG}'",\n      "url": "../'${NEXT_FULL_TAG}'/",\n      "name": "latest",\n      "preferred": true\n    },'
+  sed_runner "/\[/a\\${NEW_VERSION_ENTRY}" "${VERSIONS_FILE}"
+fi


I think you might find this easier to maintain if it was in Python.

I recommend looking into what I just did over in the docs repo:

post-processing: fix version map, use pre-commit to regenerate it rapidsai/docs#669

post-processing: re-write generate-projects-to-versions in Python rapidsai/docs#670

I think you should have a small Python script that populates versions1.json, and a pre-commit hook that runs it.

And that script should read from ./VERSION at the root of the repo.

That'd simplify update-version.sh, and make it easier to keep that file up to date.

jameslamb · 2025-08-19T21:04:28Z

ci/release/update-version.sh

+# RTD update
+sed_runner "/^set(cuopt_version/ s/[0-9][0-9].[0-9][0-9].[0-9][0-9]/${NEXT_FULL_TAG}/g" python/cuopt/CMakeLists.txt
+sed_runner "/^set(cuopt_version/ s/[0-9][0-9].[0-9][0-9].[0-9][0-9]/${NEXT_FULL_TAG}/g" python/cuopt/cuopt/linear_programming/CMakeLists.txt
+sed_runner "/^set(cuopt_version/ s/[0-9][0-9].[0-9][0-9].[0-9][0-9]/${NEXT_FULL_TAG}/g" python/libcuopt/CMakeLists.txt


It should be possible to derive all of these in CMake, at configure time, from other variables.

Re-using all of these variables:

cuopt/cmake/rapids_config.cmake

Lines 15 to 21 in b567ed4

if(_rapids_version MATCHES [[^([0-9][0-9])\.([0-9][0-9])\.([0-9][0-9])]])

set(RAPIDS_VERSION_MAJOR "${CMAKE_MATCH_1}")

set(RAPIDS_VERSION_MINOR "${CMAKE_MATCH_2}")

set(RAPIDS_VERSION_PATCH "${CMAKE_MATCH_3}")

set(RAPIDS_VERSION_MAJOR_MINOR "${RAPIDS_VERSION_MAJOR}.${RAPIDS_VERSION_MINOR}")

set(RAPIDS_VERSION "${RAPIDS_VERSION_MAJOR}.${RAPIDS_VERSION_MINOR}.${RAPIDS_VERSION_PATCH}")

else()

jameslamb · 2025-08-19T22:12:07Z

ci/release/update-version.sh

+done
+
+# PYTHON for RAPIDS
+sed_runner "/DOWNLOAD.*rapids-cmake/ s/branch-[0-9][0-9].[0-9][0-9]/branch-${NEXT_SHORT_TAG}/g" python/cuopt/CMakeLists.txt


This should be grouped with the other CMakeLists.txt updates further up.

And similar to my comment on those, I think it'd be better to move this logic into CMake code itself.

rgsl888prabhu · 2025-08-20T01:42:52Z

Approving this so you can keep moving forward. But if you haven't already, please do test it one more time, in the way I described in #286 (review)

I also think you should write up a follow-up issue about consolidating the references to versions in this project. I left a couple of suggestions, but overall there are very very many hard-coded 25.10 around the source code that all need to be kept in sync.

For inspiration, you could look at some of the PRs @KyleFromNVIDIA put up around RAPIDS implementing similar things to what I've suggested here: rapidsai/build-planning#15

Yes, I had tested by applying new version, but will test again once I have added new suggestions, thank you for such a detailed review.

rgsl888prabhu · 2025-08-20T19:34:49Z

/merge

rgsl888prabhu added 5 commits August 11, 2025 10:57

remove unused files

80a8bd9

fix doc version

66735dc

fix version

df05b60

fix version

6cdf51d

fix version

15a2333

rgsl888prabhu self-assigned this Aug 11, 2025

rgsl888prabhu requested a review from a team as a code owner August 11, 2025 16:54

rgsl888prabhu added non-breaking Introduces a non-breaking change improvement Improves an existing functionality labels Aug 11, 2025

rgsl888prabhu requested a review from jameslamb August 11, 2025 16:54

remove rapids script

85fce84

tmckayus approved these changes Aug 11, 2025

View reviewed changes

anandhkb added this to the 25.10 milestone Aug 11, 2025

jameslamb requested changes Aug 13, 2025

View reviewed changes

ci/release/update-version.sh Outdated Show resolved Hide resolved

ci/release/update-version.sh Outdated Show resolved Hide resolved

rgsl888prabhu and others added 2 commits August 14, 2025 10:35

update as per review

7062220

Merge branch 'branch-25.10' into merge_update_version

28e13dd

rgsl888prabhu requested a review from jameslamb August 14, 2025 16:24

jameslamb requested changes Aug 15, 2025

View reviewed changes

rgsl888prabhu and others added 6 commits August 15, 2025 09:31

address review changes

c2fa99a

address review comments

97743d3

pre commit changes

ce3f525

revert precommit file changes, this will be another PR

5eed69e

Merge branch 'branch-25.10' into merge_update_version

0bbd6d0

fix

85ebc9a

rgsl888prabhu requested a review from jameslamb August 15, 2025 14:48

rgsl888prabhu added 2 commits August 18, 2025 09:11

Merge branch 'branch-25.10' into merge_update_version

1dbfff5

Merge branch 'branch-25.10' into merge_update_version

3e535c7

Merge branch 'branch-25.10' into merge_update_version

6ad04e7

jameslamb approved these changes Aug 19, 2025

View reviewed changes

rapids-bot bot merged commit f869719 into NVIDIA:branch-25.10 Aug 20, 2025
73 checks passed

rgsl888prabhu mentioned this pull request Aug 20, 2025

[FEA] Fix usage of too many version like YY.MM.XX in repository #329

Closed

	if(_rapids_version MATCHES [[^([0-9][0-9])\.([0-9][0-9])\.([0-9][0-9])]])
	set(RAPIDS_VERSION_MAJOR "${CMAKE_MATCH_1}")
	set(RAPIDS_VERSION_MINOR "${CMAKE_MATCH_2}")
	set(RAPIDS_VERSION_PATCH "${CMAKE_MATCH_3}")
	set(RAPIDS_VERSION_MAJOR_MINOR "${RAPIDS_VERSION_MAJOR}.${RAPIDS_VERSION_MINOR}")
	set(RAPIDS_VERSION "${RAPIDS_VERSION_MAJOR}.${RAPIDS_VERSION_MINOR}.${RAPIDS_VERSION_PATCH}")
	else()

Merge update version and fix version format bugs #286

Merge update version and fix version format bugs #286

Uh oh!

Conversation

rgsl888prabhu commented Aug 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issue

Checklist

Uh oh!

rgsl888prabhu commented Aug 11, 2025

Uh oh!

jameslamb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

rgsl888prabhu commented Aug 13, 2025

Uh oh!

jameslamb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rgsl888prabhu commented Aug 19, 2025

Uh oh!

jameslamb left a comment

Choose a reason for hiding this comment

Uh oh!

jameslamb Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

jameslamb Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

jameslamb Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

jameslamb Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

jameslamb Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

jameslamb Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

rgsl888prabhu commented Aug 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rgsl888prabhu commented Aug 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rgsl888prabhu commented Aug 11, 2025 •

edited

Loading

rgsl888prabhu commented Aug 20, 2025 •

edited

Loading