Skip to content

fix(scripts): remove static issue line from release PR template #1596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brandonpelfrey merged 4 commits into from
Apr 8, 2026
+137 −8
Merged

fix(scripts): remove static issue line from release PR template #1596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a3731b6
fix(scripts): remove static issue line from release PR template
brandonpelfrey Apr 8, 2026
623edea
chore(release): update docs metadata during version bumps
brandonpelfrey Apr 8, 2026
36b0eb3
Update docs version from 0.1.0 to 0.0.9 in JSON
brandonpelfrey Apr 8, 2026
8d59686
Increase the slice limit for nextEntries to 10
brandonpelfrey Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/versions1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[
{
"preferred": true,
"version": "0.0.9",
"url": "https://docs.nvidia.com/nemoclaw/0.0.9/"
}
]
138 changes: 130 additions & 8 deletions scripts/bump-version.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,25 @@ type BlueprintManifest = {
[key: string]: unknown;
};

type DocsProjectJson = {
name?: string;
version?: string;
[key: string]: unknown;
};

type DocsVersionEntry = {
preferred?: boolean;
version: string;
url: string;
};

const REPO_ROOT = process.cwd();
const ROOT_PACKAGE_JSON = path.join(REPO_ROOT, "package.json");
const PLUGIN_PACKAGE_JSON = path.join(REPO_ROOT, "nemoclaw", "package.json");
const BLUEPRINT_YAML = path.join(REPO_ROOT, "nemoclaw-blueprint", "blueprint.yaml");
const DOCS_CONF = path.join(REPO_ROOT, "docs", "conf.py");
const DOCS_PROJECT_JSON = path.join(REPO_ROOT, "docs", "project.json");
const DOCS_VERSIONS_JSON = path.join(REPO_ROOT, "docs", "versions1.json");
const INSTALL_SH = path.join(REPO_ROOT, "scripts", "install.sh");
const README_MD = path.join(REPO_ROOT, "README.md");
const QUICKSTART_MD = path.join(REPO_ROOT, "docs", "get-started", "quickstart.md");
Expand All @@ -44,6 +58,8 @@ const FILES_TO_STAGE = [
PLUGIN_PACKAGE_JSON,
BLUEPRINT_YAML,
DOCS_CONF,
DOCS_PROJECT_JSON,
DOCS_VERSIONS_JSON,
INSTALL_SH,
...VERSIONED_DOC_LINK_FILES,
];
Expand Down Expand Up @@ -79,6 +95,8 @@ function main(): void {
updateBlueprintVersion(options.version);
updateInstallScriptDefaultVersion(previousVersion, options.version);
updateDocsConf(options.version);
updateDocsProjectJson(options.version);
updateDocsVersionsJson(options.version);
updateDocsVersionLinks(nextDocsPublicUrl);
updateInstallAndUninstallDocs(nextDocsVersion);

Expand Down Expand Up @@ -310,6 +328,66 @@ function updateDocsConf(nextVersion: string): void {
writeFileSync(DOCS_CONF, updated, "utf8");
}

function updateDocsProjectJson(version: string): void {
const project = readJson<DocsProjectJson>(DOCS_PROJECT_JSON);
project.version = version;
writeFileSync(DOCS_PROJECT_JSON, `${JSON.stringify(project, null, 2)}\n`, "utf8");
}

function updateDocsVersionsJson(version: string): void {
const currentEntries = readDocsVersionsJson();
const filteredEntries = currentEntries.filter((entry) => entry.version !== version);
const nextEntries: DocsVersionEntry[] = [
{
preferred: true,
version,
url: buildDocsVersionUrl(version),
},
...filteredEntries.map((entry) => ({
version: entry.version,
url: buildDocsVersionUrl(entry.version),
})),
].slice(0, 10);

writeFileSync(DOCS_VERSIONS_JSON, `${JSON.stringify(nextEntries, null, 2)}\n`, "utf8");
}

function readDocsVersionsJson(): DocsVersionEntry[] {
try {
const parsed = JSON.parse(readText(DOCS_VERSIONS_JSON)) as unknown;
if (!Array.isArray(parsed)) {
throw new Error("docs/versions1.json must contain an array");
}
return parsed.map((entry) => {
if (!entry || typeof entry !== "object") {
throw new Error("Invalid docs/versions1.json entry");
}
const candidate = entry as Partial<DocsVersionEntry>;
if (typeof candidate.version !== "string") {
throw new Error("Each docs/versions1.json entry must include a string version");
}
return {
preferred: candidate.preferred === true ? true : undefined,
version: candidate.version,
url:
typeof candidate.url === "string" && candidate.url.length > 0
? candidate.url
: buildDocsVersionUrl(candidate.version),
};
});
Comment on lines +355 to +377
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 8, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Validate retained docs versions with the same semver rule.

readDocsVersionsJson() carries forward every historical entry.version, but verifyDocsVersionsJson() only checks that it is a non-empty string. A malformed existing entry like "latest" would be rewritten with a matching URL and still pass verification, so corrupted docs metadata can survive a release bump. Reusing the parseArgs() semver check here would close that gap.

Proposed fix 
+const SEMVER_RE =
+  /^[0-9]+\.[0-9]+\.[0-9]+(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$/;
+
 function parseArgs(args: string[]): Options {
   ...
-  if (!/^[0-9]+\.[0-9]+\.[0-9]+(?:-[0-9A-Za-z.-]+)?(?:\+[0-9A-Za-z.-]+)?$/.test(version)) {
+  if (!SEMVER_RE.test(version)) {
     throw new Error(`Invalid semver: ${version}`);
   }
   ...
 }
-      if (typeof candidate.version !== "string") {
-        throw new Error("Each docs/versions1.json entry must include a string version");
+      if (typeof candidate.version !== "string" || !SEMVER_RE.test(candidate.version)) {
+        throw new Error("Each docs/versions1.json entry must include a valid semver version");
       }
-    if (typeof entry.version !== "string" || entry.version.length === 0) {
+    if (typeof entry.version !== "string" || !SEMVER_RE.test(entry.version)) {
       throw new Error(`docs/versions1.json entry ${index} is missing a valid version`);
     }

Also applies to: 622-657

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@scripts/bump-version.ts` around lines 355 - 377, readDocsVersionsJson
currently accepts any non-empty string for historical entry.version, allowing
malformed versions like "latest" to be preserved; update readDocsVersionsJson to
validate each candidate.version using the same semver parsing/validation used by
parseArgs() (or reuse the parseArgs semver check function) and throw an error if
the version is not a valid semver; keep the existing URL logic (use
candidate.url if valid otherwise buildDocsVersionUrl(candidate.version)) and
ensure preferred handling remains unchanged so malformed versions cannot be
carried forward.

} catch (error) {
const err = error as NodeJS.ErrnoException;
if (err.code === "ENOENT") {
return [];
}
throw error;
}
}

function buildDocsVersionUrl(version: string): string {
return `https://docs.nvidia.com/nemoclaw/${version}/`;
}

function updateDocsVersionLinks(nextDocsPublicUrl: string): void {
for (const filePath of VERSIONED_DOC_LINK_FILES) {
const current = readText(filePath);
Expand Down Expand Up @@ -362,6 +440,8 @@ function verifyVersionState(version: string, docsPublicUrl: string, docsDisplayV

requireContains(INSTALL_SH, `DEFAULT_NEMOCLAW_VERSION="${version}"`);
requireContains(DOCS_CONF, `release = "${version}"`);
assertEqual(readJson<DocsProjectJson>(DOCS_PROJECT_JSON).version, version, "docs/project.json version mismatch");
verifyDocsVersionsJson(version);
requireContains(README_MD, docsPublicUrl);
requireContains(README_MD, docsDisplayVersion);
requireContains(QUICKSTART_MD, docsDisplayVersion);
Expand Down Expand Up @@ -406,7 +486,10 @@ function createReleasePr(options: Options, previousVersion: string, tagName: str
git(["commit", "-m", `chore(release): bump version to ${tagName}`]);
git(["push", "-u", "origin", options.branchName]);

const prBody = buildPrBody(previousVersion, options.version);
const prBody = buildPrBody(previousVersion, options.version, {
ranTests: !options.skipTests,
ranFormat: false,
});
const prUrl = run(
"gh",
[
Expand Down Expand Up @@ -441,7 +524,12 @@ function gitRemoteBranchExists(branchName: string): boolean {
return run("git", ["ls-remote", "--exit-code", "--heads", "origin", branchName], { allowFailure: true }).exitCode === 0;
}

function buildPrBody(previousVersion: string, nextVersion: string): string {
type PrBodyOptions = {
ranTests: boolean;
ranFormat: boolean;
};

function buildPrBody(previousVersion: string, nextVersion: string, options: PrBodyOptions): string {
const gitUserName = run("git", ["config", "user.name"]).trim();
const gitUserEmail = run("git", ["config", "user.email"]).trim();

Expand All @@ -457,9 +545,6 @@ function buildPrBody(previousVersion: string, nextVersion: string): string {
`Bump NemoClaw from ${previousVersion} to ${nextVersion} across the CLI package, plugin package,`,
"blueprint manifest, installer defaults, and versioned docs references.",
"",
"## Related Issue",
"Fixes #1577.",
"",
"## Changes",
`- bump release version from ${previousVersion} to ${nextVersion}`,
"- update installer and docs version references to match the npm/package version",
Expand All @@ -472,8 +557,8 @@ function buildPrBody(previousVersion: string, nextVersion: string): string {
"- [ ] Doc only. Includes code sample changes.",
"",
"## Testing",
"- [ ] `npx prek run --all-files` passes (or equivalently `make check`).",
"- [x] `npm test` passes.",
`- [${options.ranFormat ? "x" : " "}] \`npx prek run --all-files\` passes (or equivalently \`make check\`).`,
`- [${options.ranTests ? "x" : " "}] \`npm test\` passes.`,
"- [ ] `make docs` builds without warnings. (for doc-only changes)",
"",
"## Checklist",
Expand All @@ -484,7 +569,7 @@ function buildPrBody(previousVersion: string, nextVersion: string): string {
"- [ ] I have read and followed the [style guide](https://github.com/NVIDIA/NemoClaw/blob/main/docs/CONTRIBUTING.md). (for doc-only changes)",
"",
"### Code Changes",
"- [x] Formatters applied — `npx prek run --all-files` auto-fixes formatting (or `make format` for targeted runs).",
`- [${options.ranFormat ? "x" : " "}] Formatters applied — \`npx prek run --all-files\` auto-fixes formatting (or \`make format\` for targeted runs).`,
"- [ ] Tests added or updated for new or changed behavior.",
"- [x] No secrets, API keys, or credentials committed.",
"- [x] Doc pages updated for any user-facing behavior changes (new commands, changed defaults, new features, bug fixes that contradict existing docs).",
Expand Down Expand Up @@ -534,6 +619,43 @@ function requireContains(filePath: string, text: string): void {
}
}

function verifyDocsVersionsJson(expectedNewestVersion: string): void {
const entries = readJson<DocsVersionEntry[]>(DOCS_VERSIONS_JSON);
if (!Array.isArray(entries)) {
throw new Error("docs/versions1.json must contain an array");
}
if (entries.length === 0) {
throw new Error("docs/versions1.json must contain at least one version entry");
}
if (entries.length > 5) {
throw new Error(`docs/versions1.json must contain at most 5 entries; found ${entries.length}`);
}

entries.forEach((entry, index) => {
if (typeof entry.version !== "string" || entry.version.length === 0) {
throw new Error(`docs/versions1.json entry ${index} is missing a valid version`);
}
const expectedUrl = buildDocsVersionUrl(entry.version);
if (entry.url !== expectedUrl) {
throw new Error(
`docs/versions1.json entry ${index} has url '${entry.url}', expected '${expectedUrl}'`,
);
}
if (index === 0) {
if (entry.version !== expectedNewestVersion) {
throw new Error(
`docs/versions1.json first entry must be ${expectedNewestVersion}; found ${entry.version}`,
);
}
if (entry.preferred !== true) {
throw new Error("docs/versions1.json first entry must have preferred: true");
}
} else if ("preferred" in entry && entry.preferred !== undefined) {
throw new Error("Only the first docs/versions1.json entry may set preferred");
}
});
}

function verifyDocsLinks(filePath: string, expectedDocsPublicUrl: string): void {
const content = readText(filePath);
const matches = Array.from(
Expand Down
Loading