An open source design system that's fully customizable and agent ready
TypeScript
fix(ci): the merge-base build script parses again; every workflow run script must pass bash -n (#9373)
Cindy Zhangb7c2ce838cd5
diff --git a/.github/scripts/ci-run-scripts-parse.test.mjs b/.github/scripts/ci-run-scripts-parse.test.mjsnew file mode 100644index 0000000000..c82451f631--- /dev/null+++ b/.github/scripts/ci-run-scripts-parse.test.mjs@@ -0,0 +1,117 @@+// Copyright (c) Meta Platforms, Inc. and affiliates.++/**+ * @file ci-run-scripts-parse.test.mjs+ * @input Every workflow under .github/workflows and every composite action+ * under .github/actions+ * @output Fails when a step's bash `run:` script does not parse+ * @position Contract test for the repository's GitHub Actions scripts+ * (spec:AST-030 FR11)+ *+ * A script that does not parse fails its step on every run that reaches it,+ * whatever the pull request changes. A common cause is an apostrophe in a+ * comment or message inside a single-quoted `bash -c '...'` body: it closes+ * the quote early, and the rest of the body becomes shell syntax.+ *+ * Each `run:` script runs through `bash -n`, which parses without executing,+ * and so does each single-quoted script it hands to `bash -c '...'` or+ * `sh -c '...'`. `${{ ... }}` expressions are replaced with a plain word+ * first, the way the runner substitutes them before bash sees the script.+ * Steps whose `shell:` is not bash are skipped.+ */++import {spawnSync} from 'node:child_process';+import fs from 'node:fs';+import path from 'node:path';+import {fileURLToPath} from 'node:url';+import {describe, expect, it} from 'vitest';+import yaml from 'yaml';++const githubDir = path.resolve(+ path.dirname(fileURLToPath(import.meta.url)),+ '..',+);++/** Workflow and composite-action files, relative to the repository root. */+function workflowFiles() {+ const workflows = fs+ .readdirSync(path.join(githubDir, 'workflows'))+ .filter(name => /\.ya?ml$/.test(name))+ .map(name => path.join('workflows', name));+ const actions = fs+ .readdirSync(path.join(githubDir, 'actions'), {withFileTypes: true})+ .filter(entry => entry.isDirectory())+ .flatMap(entry =>+ ['action.yml', 'action.yaml']+ .map(name => path.join('actions', entry.name, name))+ .filter(file => fs.existsSync(path.join(githubDir, file))),+ );+ return [...workflows, ...actions];+}++/**+ * Every bash `run:` script in one file, labelled by job (or action) and step.+ *+ * @param {string} file path relative to .github+ * @returns {{label: string, script: string}[]}+ */+function runScripts(file) {+ const doc = yaml.parse(fs.readFileSync(path.join(githubDir, file), 'utf8'));+ /** @type {[string, any[], string | undefined][]} */+ const stepLists = [];+ for (const [jobId, job] of Object.entries(doc?.jobs ?? {})) {+ const jobShell = /** @type {any} */ (job)?.defaults?.run?.shell;+ stepLists.push([+ jobId,+ /** @type {any} */ (job)?.steps ?? [],+ jobShell ?? doc?.defaults?.run?.shell,+ ]);+ }+ if (Array.isArray(doc?.runs?.steps)) {+ stepLists.push(['(action)', doc.runs.steps, undefined]);+ }+ /** @type {{label: string, script: string}[]} */+ const out = [];+ for (const [owner, steps, defaultShell] of stepLists) {+ steps.forEach((step, index) => {+ if (typeof step?.run !== 'string') return;+ const shell = String(step.shell ?? defaultShell ?? 'bash');+ if (!/^bash\b/.test(shell)) return;+ const label = `${file} › ${owner} › ${step.name ?? step.id ?? `step ${index + 1}`}`;+ const script = step.run.replace(/\$\{\{[\s\S]*?\}\}/g, 'EXPR');+ out.push({label, script});+ // A single-quoted body cannot contain a quote, so it ends at the next one.+ let nested = 0;+ for (const match of script.matchAll(+ /\b(?:ba)?sh\s+(?:-\w+\s+)*-c\s+'([^']*)'/g,+ )) {+ nested += 1;+ out.push({+ label: `${label} › inner script ${nested}`,+ script: match[1],+ });+ }+ });+ }+ return out;+}++const scripts = workflowFiles().flatMap(runScripts);++describe('workflow run scripts', () => {+ it('finds the scripts it checks', () => {+ expect(scripts.length).toBeGreaterThan(50);+ });++ it.each(scripts.map(({label, script}) => [label, script]))(+ '%s parses as bash',+ (_label, script) => {+ const result = spawnSync('bash', ['-n'], {+ input: script,+ encoding: 'utf8',+ });+ expect(result.stderr.trim()).toBe('');+ expect(result.status).toBe(0);+ },+ );+});diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.ymlindex 9512e6bece..ce65dca24c 100644--- a/.github/workflows/ci.yml+++ b/.github/workflows/ci.yml@@ -1224,7 +1224,7 @@ jobs:# packages depend on them. Another package builds only when the# pull request changes its source. A published package the base# leaves unbuilt is reported from the head build only when none of- # its report inputs changed (the API report CLI's SHARED_INPUTS);+ # its report inputs changed (SHARED_INPUTS in the API report CLI);# otherwise from its committed report.pnpm -F @astryxdesign/build buildpnpm -F @astryxdesign/core build@@ -1239,7 +1239,7 @@ jobs:done# The CLI publishes declarations generated from its JSDoc.git diff --quiet "$BASE_SHA" "$HEAD_SHA" -- packages/cli || pnpm -F @astryxdesign/cli sync:api-types- } || echo "Building the merge base's published packages failed; those packages compare with its committed reports."+ } || echo "Building the published packages of the merge base failed; those packages compare with its committed reports."fitouch ../base-build.done' > base-build.log 2>&1 || touch base-build.failed &