githubmirror/components

scripts/create-package-archives.mjs
79 строк2 KB
Kristiyan Kostadinov
build: avoid command injection when creating package archives
11 июн 2026, 14:06
11 июн 2026, 14:06a91677b
#!/usr/bin/env node

/**
 * Script that creates tar archives of built release packages. These archives can then
 * be uploaded to the CircleCI artifacts so that PRs or individual commits can be easily
 * tested out without having to build the release packages manually, and packing them up.
 *
 * This is different to the snapshot builds repositories as those only are available for
 * the primary `cdk` and `material` packages, and also don't run for pull requests.
 */

import {join} from 'path';
import {execFileSync} from 'child_process';
import sh from 'shelljs';
import chalk from 'chalk';
import yargs from 'yargs';

const archivesDir = 'dist/release-archives';
const releasesDir = 'dist/releases';
const {suffix} = yargs(process.argv.slice(2))
  .option('suffix', {type: 'string', demandOption: true})
  .strict()
  .parseSync();

// Fail if any ShellJS command fails.
sh.set('-e');

if (!sh.test('-e', releasesDir)) {
  console.error(chalk.red('The release output has not been built.'));
  process.exit(1);
}

sh.rm('-Rf', archivesDir);
sh.mkdir('-p', archivesDir);

const builtPackages = sh
  .ls(releasesDir)
  .map(name => ({name, path: join(releasesDir, name)}))
  .filter(pkg => sh.test('-d', pkg.path));

// If multiple packages should be archived, we also generate a single archive that
// contains all packages. This makes it easier to transfer the release packages.
if (builtPackages.length > 1) {
  console.info('Creating archive with all packages...');
  execFileSync(
    'tar',
    [
      '--create',
      '--gzip',
      '--directory',
      releasesDir,
      '--file',
      `${archivesDir}/all-${suffix}.tgz`,
      '.',
    ],
    {stdio: 'inherit'},
  );
}

// Note that we're using `exec` here, rather than interpolating the arguments into `sh.exec`,
// to avoid a potential command injection through the `suffix` which is user-provided.
for (const pkg of builtPackages) {
  console.info(`Creating archive for package: ${pkg.name}`);
  execFileSync(
    'tar',
    [
      '--create',
      '--gzip',
      '--directory',
      pkg.path,
      '--file',
      `${archivesDir}/${pkg.name}-${suffix}.tgz`,
      '.',
    ],
    {stdio: 'inherit'},
  );
}

console.info(chalk.green(`Created package archives in: ${archivesDir}`));