Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-04-02 08:15:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix Azure pipeline parameter whitespace handling (#304065)

Browse Source 
fix: update Azure CLI command handling to support parameter values with spaces and improve usage documentation
This commit is contained in:
João Moreno
2026-03-23 20:27:07 +01:00
committed by GitHub
parent 1771717f2a
commit 70019df4c3
2 changed files with 20 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
.github/skills/azure-pipelines/SKILL.md vendored
View File

@@ -92,8 +92,8 @@ node .github/skills/azure-pipelines/azure-pipeline.ts queue --parameter "VSCODE_
|--------|-------------|
| `--branch <name>` | Source branch to build (default: current git branch) |
| `--definition <id>` | Pipeline definition ID (default: 111) |
| `--parameter <entry>` | Pipeline parameter in `KEY=value` format (repeatable) |
| `--parameters <list>` | Space-separated parameters in `KEY=value KEY2=value2` format |
| `--parameter <entry>` | Pipeline parameter in `KEY=value` format (repeatable); **use this when the value contains spaces** |
| `--parameters <list>` | Space-separated parameters in `KEY=value KEY2=value2` format; values **must not** contain spaces |
| `--dry-run` | Print the command without executing |
### Product Build Queue Parameters (`build/azure-pipelines/product-build.yml`)

22
.github/skills/azure-pipelines/azure-pipeline.ts vendored
View File

@@ -556,7 +556,11 @@ class AzureDevOpsClient {
protected runAzCommand(args: string[]): Promise<string> {
return new Promise((resolve, reject) => {
const proc = spawn('az', args, { shell: true });
// Use shell: false so that argument values with spaces are passed verbatim
// to the process without shell word-splitting. On Windows, az is a .cmd
// file and cannot be executed directly, so we must use az.cmd.
const azBin = process.platform === 'win32' ? 'az.cmd' : 'az';
const proc = spawn(azBin, args, { shell: false });
let stdout = '';
let stderr = '';
@@ -778,8 +782,8 @@ function printQueueUsage(): void {
console.log('Options:');
console.log(' --branch <name> Source branch to build (default: current git branch)');
console.log(' --definition <id> Pipeline definition ID (default: 111)');
console.log(' --parameter <entry> Pipeline parameter in "KEY=value" format (repeatable)');
console.log(' --parameters <list> Space-separated parameter list in "KEY=value KEY2=value2" format');
console.log(' --parameter <entry> Pipeline parameter in "KEY=value" format (repeatable); use this for values with spaces');
console.log(' --parameters <list> Space-separated parameter list in "KEY=value KEY2=value2" format (values must not contain spaces)');
console.log(' --dry-run Print the command without executing');
console.log(' --help Show this help message');
console.log('');
@@ -887,7 +891,8 @@ async function runQueueCommand(args: string[]): Promise<void> {
cmdArgs.push('--parameters', ...parsedArgs.parameters);
}
cmdArgs.push('--output', 'json');
console.log(`az ${cmdArgs.join(' ')}`);
const displayArgs = cmdArgs.map(a => a.includes(' ') ? `"${a}"` : a);
console.log(`az ${displayArgs.join(' ')}`);
process.exit(0);
}
@@ -1539,6 +1544,15 @@ async function runAllTests(): Promise<void> {
assert.ok(cmd.includes('OTHER=test'));
});
it('queueBuild passes parameter values with spaces verbatim', async () => {
const client = new TestableAzureDevOpsClient(ORGANIZATION, PROJECT);
await client.queueBuild('111', 'main', ['VSCODE_BUILD_TYPE=Product Build']);
const cmd = client.capturedCommands[0];
assert.ok(cmd.includes('--parameters'));
assert.deepStrictEqual(cmd[cmd.indexOf('--parameters') + 1], 'VSCODE_BUILD_TYPE=Product Build');
});
it('getBuild constructs correct az command', async () => {
const client = new TestableAzureDevOpsClient(ORGANIZATION, PROJECT);
await client.getBuild('12345');