Update sync-back script

This is intended as a workaround until https://github.com/github/codeql-action/pull/3556 is merged.
This commit is contained in:
Henry Mercer
2026-06-03 17:21:10 +01:00
parent 87f4948cb0
commit fd3f10809d
2 changed files with 62 additions and 5 deletions

View File

@@ -188,6 +188,41 @@ const steps = [
const result = updateSyncTs(syncTsPath, actionVersions);
assert.equal(result, false);
});
await it("updates SHA-pinned pinnedUses references", () => {
/** Test updating `pinnedUses(...)` references with new SHA and version */
const syncTsContent = `
const steps = [
{
uses: pinnedUses(
"actions/setup-node",
"0000000000000000000000000000000000000000",
"v6.0.0",
),
},
];
`;
fs.writeFileSync(syncTsPath, syncTsContent);
const actionVersions = {
"actions/setup-node": "48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0",
};
const result = updateSyncTs(syncTsPath, actionVersions);
assert.equal(result, true);
const updatedContent = fs.readFileSync(syncTsPath, "utf8");
assert.ok(
updatedContent.includes('"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e"'),
);
assert.ok(updatedContent.includes('"v6.4.0"'));
assert.ok(
!updatedContent.includes("0000000000000000000000000000000000000000"),
);
assert.ok(!updatedContent.includes('"v6.0.0"'));
});
});
describe("updateTemplateFiles", async () => {

View File

@@ -68,6 +68,10 @@ export function scanGeneratedWorkflows(
/**
* Update hardcoded action versions in pr-checks/sync.ts
*
* Handles both inline `uses: "owner/action@ref"` strings and SHA-pinned
* references expressed via the `pinnedUses("owner/action", "<sha>", "version")`
* helper.
*
* @param syncTsPath - Path to sync.ts file
* @param actionVersions - Map of action names to versions (may include comments)
* @returns True if the file was modified, false otherwise
@@ -87,18 +91,36 @@ export function updateSyncTs(
for (const [actionName, versionWithComment] of Object.entries(
actionVersions,
)) {
// Extract just the version part (before any comment) for sync.ts
const version = versionWithComment.includes("#")
// Split the scanned value into the ref (e.g. a commit SHA) and the optional
// trailing version comment (e.g. `v6.0.3`).
const ref = versionWithComment.includes("#")
? versionWithComment.split("#")[0].trim()
: versionWithComment.trim();
const versionComment = versionWithComment.includes("#")
? versionWithComment.split("#")[1].trim()
: "";
const escaped = actionName.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
// Look for patterns like uses: "actions/setup-node@v4"
// Note that this will break if we store an Action uses reference in a
// variable - that's a risk we're happy to take since in that case the
// PR checks will just fail.
const escaped = actionName.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
const pattern = new RegExp(`(uses:\\s*")${escaped}@(?:[^"]+)(")`, "g");
content = content.replace(pattern, `$1${actionName}@${version}$2`);
const usesPattern = new RegExp(`(uses:\\s*")${escaped}@(?:[^"]+)(")`, "g");
content = content.replace(usesPattern, `$1${actionName}@${ref}$2`);
// Look for SHA-pinned references expressed via the `pinnedUses` helper, e.g.
// `pinnedUses("actions/checkout", "<sha>", "v6.0.3")`, updating both the
// pinned ref and the version comment.
const pinnedPattern = new RegExp(
`(pinnedUses\\(\\s*")${escaped}("\\s*,\\s*")[^"]*("\\s*,\\s*")([^"]*)(")`,
"g",
);
content = content.replace(
pinnedPattern,
(_match, p1, p2, p3, oldVersion, p5) =>
`${p1}${actionName}${p2}${ref}${p3}${versionComment || oldVersion}${p5}`,
);
}
if (content !== originalContent) {