Skip to content

Prevent command injection in CLI docs build script #2536

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

Open
fnando wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Prevent command injection in CLI docs build script #2536

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d2da90
Prevent command injection in CLI docs build script.
fnando Jun 25, 2026
f084036
Update comment.
fnando Jun 25, 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
29 changes: 16 additions & 13 deletions scripts/stellar_cli.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import fs from "fs-extra";
import path from "path";
import { execSync } from "child_process";
import { execFileSync } from "child_process";
import yargs from "yargs";
import { hideBin } from "yargs/helpers";

Expand All @@ -23,25 +23,28 @@ if (fs.existsSync(localRepoPath)) {
fs.removeSync(localRepoPath);
}

// Perform a shallow clone of the repository
// Clone the repository
console.log("Cloning repository...");
execSync(`git clone ${repoUrl} ${localRepoPath}`);
execSync(
`cd ${localRepoPath} && git fetch --all && git fetch origin '+refs/pull/*/merge:refs/remotes/origin/pr/*/merge'`,
execFileSync("git", ["clone", repoUrl, localRepoPath]);
execFileSync("git", ["fetch", "--all"], { cwd: localRepoPath });
execFileSync(
"git",
["fetch", "origin", "+refs/pull/*/merge:refs/remotes/origin/pr/*/merge"],
{ cwd: localRepoPath },
);
const latestVersion = execSync(
`cd ${localRepoPath} && git tag | grep -v -E 'rc|preview' | tail -n1`,
)
const tag = execFileSync("git", ["tag"], { cwd: localRepoPath })
.toString()
.substring(1)
.trim();

.trimEnd()
.split(/\r?\n/)
.filter((tag) => !tag.match(/rc|preview/))
.pop();
const latestVersion = tag.toString().substring(1).trim();
Comment thread
fnando marked this conversation as resolved.
const cliRef = argv.cliRef || `v${latestVersion}`;

console.log("the latest version is", latestVersion.toString());
console.log("using cli ref to fetch cli docs: ", cliRef.toString());

execSync(`cd ${localRepoPath} && git checkout --quiet ${cliRef}`);
execFileSync("git", ["checkout", "--quiet", cliRef], { cwd: localRepoPath });

// Copy FULL_HELP_DOCS.md
const fullHelpDocsPath = path.join(localRepoPath, "FULL_HELP_DOCS.md");
Expand All @@ -66,6 +69,6 @@ fs.cpSync(path.join(localRepoPath, "cookbook"), "docs/tools/cli/cookbook", {
recursive: true,
});

execSync("pnpm format:mdx");
execFileSync("pnpm", ["format:mdx"]);

console.log("All files processed successfully.");
Loading