Add tooling to bump container-toolkit version

[elezar]

No description provided.

[github-actions]

Documentation preview

https://nvidia.github.io/cloud-native-docs/review/pr-185

[a-mccarthy]

Do you think its necessary to update the known issue section of 1.17.7 with a recommendation to upgrade to using 1.17.8 to avoid the bug? possibly unnecessary, since we already mention in the current note that the issue is fixed in the next patch release

[elezar]

I don't think so. We also call out:

If you are impacted by this issue, its recommended that you continue to use Container Toolkit v1.17.6 and pin all dependencies to v1.17.6 until this issue is resolved in the next patch release.

[a-mccarthy]

just to confirm, this script is to allow folks to update all the version information for a component without having to manually update the files?

Some notes, all the components have a version (old format) and version1 (new format) file. So we'd have to also update the version file for each component to use the new format, right?

[elezar]

Yes, that was the intent of this script. Note that I still don't see the purpose for having both version files present in the repo at a given time -- but maybe my understanding of the document generation is incomplete.

[cdesiniotis]

@a-mccarthy the overall content lgtm. Feel free to directly apply your suggestions / nits. I think we can proceed and merge this while @elezar is out.

[mikemckiernan]

Before doing it this way, please consider using source_subtitutions.

[mikemckiernan]

There were two reasons for using versions1.json:

• It avoided clobbering the older format that was used before NVIDIA Sphinx Theme. This way, if someone stumbled on an older version of the docs, the version menu would still work.
• Naming the file versions1.json is a bit of a convention across docs projects at NVIDIA, kinda because we've nearly all migrated to using NVIDIA Sphinx Theme.

IMO, not worth changing and kind of worth it to keep as-is for continuity across projects.

[elezar]

Question: Are the docs not built from a specific commit? Meaning that as long as that specific commit has the "correct" version information then using versions.json should be fine?

Change scope of PR.

[Copilot]

Pull Request Overview

This PR introduces a new shell script to bump the container-toolkit version while migrating file references from versions1.json to versions.json. Key changes include:

• Adding a new script (scripts/bump-version.sh) to automate version bumps.
• Updating repo.toml and README.md to reference versions.json.
• Removing the outdated container-toolkit/versions1.json file.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
scripts/bump-version.sh	New version bump script using yq and sed for updating version info
repo.toml	Updated file paths to reference versions.json
container-toolkit/versions1.json	Removed outdated version JSON file
container-toolkit/versions.json	Introduced new version JSON schema with added fields
README.md	Documentation updated to reflect changes in version file names

[Copilot]

[nitpick] The complex inline yq command impacts readability and maintainability; consider refactoring parts into intermediate variables or adding inline comments to clarify its intent.

Suggested change

	yq -p=json -o=json -i '. = [{"preferred": "true", "url": "../'"${NEW_VERSION}"'", "version": "'"${NEW_VERSION}"'"}] + [(.[0] | del(.preferred))] + .[1:]' "$VERSIONS_JSON"
	echo "Preparing new version entry for $VERSIONS_JSON..."
	NEW_VERSION_ENTRY='[{"preferred": "true", "url": "../'"${NEW_VERSION}"'", "version": "'"${NEW_VERSION}"'"}]'
	REMOVE_PREFERRED='[(.[0] | del(.preferred))]'
	REMAINING_ENTRIES='.[1:]'
	# Update the versions.json file with the new version entry
	yq -p=json -o=json -i ". = ${NEW_VERSION_ENTRY} + ${REMOVE_PREFERRED} + ${REMAINING_ENTRIES}" "$VERSIONS_JSON"