Convert `sync.py` to TypeScript by mbg · Pull Request #3526 · github/codeql-action

mbg · 2026-02-28T18:20:46Z

This PR takes a first step at converting a script from Python to TypeScript. Concretely, it replaces the sync.py script that turns our PR check specifications into GitHub Actions workflows with a roughly equivalent TypeScript replacement.

Initially, I aimed for exact textual equivalence in the output between the two scripts, but then I ultimately allowed a few minor changes:

The formatting of the steps from the specification is now preserved more accurately.
- This mainly allows more comments from the specification to be preserved and in more accurate locations.
- There are also some cases where there are now quoted strings in the output where there weren't quotes before. For consistency, all double quoted strings in the steps are converted to single quoted strings.
The yaml package allows for unlimited line length, which ruamel.yaml didn't quite handle correctly before, so some lines are no longer wrapped as intended.

I initially started by using js-yaml, since we already use this elsewhere in the repo, but then switched to yaml since it gave me more control over the formatting.

Follow-up in #3529 for sync_back.py.

Risk assessment

For internal use only. Please select the risk level of this change:

Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.

Which use cases does this change impact?

Environments:

Testing/None - This change does not impact any CodeQL workflows in production.

How did/will you validate this change?

End-to-end tests - I am depending on PR checks (i.e. tests in pr-checks).

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.

How will you know if something goes wrong after this change is released?

Other - Please provide details.

Are there any special considerations for merging or releasing this change?

No special considerations - This change can be merged at any time.

Merge / deployment checklist

Confirm this change is backwards compatible with existing workflows.
Consider adding a changelog entry for this change.
Confirm the readme and docs have been updated if necessary.

Copilot

Pull request overview

Replaces the Python-based PR-check workflow generator with a TypeScript implementation, updating the workflow-generation toolchain and regenerating the affected __*.yml workflows under .github/workflows.

Changes:

Added pr-checks/sync.ts (TypeScript replacement for sync.py) using the yaml package to preserve step formatting/comments.
Updated pr-checks/sync.sh to run the new generator via tsx and introduced a dedicated pr-checks/package.json + lockfile.
Regenerated the __*.yml workflows and made small formatting adjustments in a couple of check specs.

Reviewed changes

Copilot reviewed 42 out of 45 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
tsconfig.json	Excludes `pr-checks` from the main TypeScript compilation scope.
eslint.config.mjs	Ignores `pr-checks/**` for ESLint runs.
pr-checks/sync.ts	New TypeScript workflow generator (replaces Python behavior).
pr-checks/sync.sh	Switches generator execution from Python/ruamel to Node/tsx.
pr-checks/package.json	Adds Node dependencies needed to run `sync.ts`.
pr-checks/package-lock.json	Locks `pr-checks` generator dependencies for reproducibility.
pr-checks/.gitignore	Ignores `pr-checks/node_modules`.
pr-checks/checks/upload-sarif.yml	Minor formatting/quoting changes in `if:` conditions.
pr-checks/checks/bundle-from-nightly.yml	Minor formatting change to `if:` condition style.
.github/workflows/__all-platform-bundle.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__analysis-kinds.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__analyze-ref-input.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__autobuild-action.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__autobuild-direct-tracing-with-working-dir.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__build-mode-autobuild.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__build-mode-manual.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__build-mode-none.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__build-mode-rollback.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__bundle-from-nightly.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__cleanup-db-cluster-dir.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__config-export.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__diagnostics-export.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__export-file-baseline-information.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__go-custom-queries.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__go-indirect-tracing-workaround-diagnostic.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__go-indirect-tracing-workaround-no-file-program.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__init-with-registries.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__job-run-uuid-sarif.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__language-aliases.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__local-bundle.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__multi-language-autodetect.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__packaging-codescanning-config-inputs-js.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__packaging-config-inputs-js.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__packaging-config-js.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__packaging-inputs-js.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__remote-config.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__resolve-environment-action.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__split-workflow.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__start-proxy.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__submit-sarif-failure.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__swift-custom-build.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__unset-environment.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__upload-ref-sha-input.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__upload-sarif.yml	Regenerated workflow output (formatting/quoting changes).
.github/workflows/__with-checkout-path.yml	Regenerated workflow output (formatting/quoting changes).

Files not reviewed (1)

pr-checks/package-lock.json: Language not supported

pr-checks/sync.ts

pr-checks/sync.sh

esbena

(submitting probably empty review for technical reasons, complete review will follow)

esbena · 2026-03-02T11:05:56Z

pr-checks/sync.ts

+        "setup-kotlin": String(
+          !("container" in checkSpecification),


This seems somehow like the dual of the (convoluted IMO) isTruthy introduced earlier.
My preference is to be more explicit here with a ternary that produces literal true/false:

Suggested change

"setup-kotlin": String(

!("container" in checkSpecification),

"setup-kotlin": "container" in checkSpecification? "false": "true"

esbena · 2026-03-02T11:05:56Z

pr-checks/sync.ts

+      extraGroupName += "-${{inputs." + inputName + "}}";
+    }


Lets do a very simple sanitization check here, namely that the input name is a valid identifier.
It's not so much for security I worry, it's rather just the ease of diagnosing invalid workflow files.

esbena · 2026-03-02T11:05:56Z

pr-checks/sync.ts

+      combinedInputs = { ...combinedInputs, ...checkInputs };
+
+      for (const inputName of Object.keys(checkInputs)) {
+        checkWith[inputName] = "${{ inputs." + inputName + " }}";


Ditto the earlier comment about sanitization

esbena · 2026-03-02T11:09:22Z

pr-checks/sync.ts

+    let useAllPlatformBundle = "false"; // Default to false
+    if (checkSpecification.useAllPlatformBundle) {
+      useAllPlatformBundle = checkSpecification.useAllPlatformBundle;
+    }


This should be a one liner.

Suggested change

let useAllPlatformBundle = "false"; // Default to false

if (checkSpecification.useAllPlatformBundle) {

useAllPlatformBundle = checkSpecification.useAllPlatformBundle;

}

const useAllPlatformBundle = checkSpecification.useAllPlatformBundle? checkSpecification.useAllPlatformBundle: false;

or

Suggested change

let useAllPlatformBundle = "false"; // Default to false

if (checkSpecification.useAllPlatformBundle) {

useAllPlatformBundle = checkSpecification.useAllPlatformBundle;

}

const useAllPlatformBundle = !!checkSpecification.useAllPlatformBundle;

esbena · 2026-03-02T11:10:54Z

pr-checks/sync.ts

+  fs.writeFileSync(filePath, stripTrailingWhitespace(header + yamlStr), "utf8");
+}
+
+function isTruthy(value: string | boolean | undefined): boolean {


This function needs a comment, but I'm not sure about the existence at all actually. The truthiness check in JavaScript is widely known to be !!value. This implementation changes it very subtly.
Perhaps a rename to something like isBooleanTrueOrStringTrue?

esbena · 2026-03-02T11:12:10Z

LGTM, I only have some stylistic comments. The migration is pleasantly simple, and the near zero-diff strategy seems robust enough here.

mbg added 22 commits February 28, 2026 15:58

Scaffold project for sync.ts script

c7e378f

Add specification types

2f77cd0

Add defaultTestVersions constant

04c1e60

Strip trailing whitespace in output

898d46e

Add isTruthy helper

efe64e0

Add basic workflow construction

40aefb0

Add concurrency settings

6932b1c

Add matrix construction

63b4776

Add job construction

e62a268

Add matrix to job

dd78add

Add permissions

9a0fe9e

Add CODEQL_ACTION_TEST_MODE

b77ebbe

Add env, container, and services

c889588

Add basic job steps

b948e56

Add useAllPlatformBundle

d52917b

Add analysisKinds

57c7bc6

Add tool-specific setup steps

96e6b65

Track collections

47671ab

Generate and write collections

a85af80

Switch from js-yaml to yaml for better output formatting

0ea8490

Switch sync.sh script to only use sync.ts

5876a93

Adjust quotes and re-generate workflows

f91cab1

mbg self-assigned this Feb 28, 2026

github-actions bot added the size/XXL May be extremely hard to review label Feb 28, 2026

mbg marked this pull request as ready for review March 1, 2026 14:52

mbg requested a review from a team as a code owner March 1, 2026 14:52

Copilot AI review requested due to automatic review settings March 1, 2026 14:52

Copilot started reviewing on behalf of mbg March 1, 2026 14:52 View session

Copilot AI reviewed Mar 1, 2026

View reviewed changes

pr-checks/sync.ts Show resolved Hide resolved

pr-checks/sync.sh Outdated Show resolved Hide resolved

Run npm ci in actions

8bfaf96

mbg added 2 commits March 1, 2026 16:03

Replace remaining uses of sync.py

e931a24

Remove sync.py

f0f92a1

mbg mentioned this pull request Mar 1, 2026

Convert sync_back.py to TypeScript #3529

Draft

esbena reviewed Mar 2, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert `sync.py` to TypeScript#3526

Convert `sync.py` to TypeScript#3526
mbg wants to merge 25 commits intomainfrom
mbg/pr-checks/ts

mbg commented Feb 28, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

esbena left a comment

Uh oh!

esbena Mar 2, 2026

Uh oh!

esbena Mar 2, 2026

Uh oh!

esbena Mar 2, 2026

Uh oh!

esbena Mar 2, 2026

Uh oh!

esbena Mar 2, 2026

Uh oh!

esbena commented Mar 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		"setup-kotlin": String(
		!("container" in checkSpecification),

	"setup-kotlin": String(
	!("container" in checkSpecification),
	"setup-kotlin": "container" in checkSpecification? "false": "true"

Conversation

mbg commented Feb 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Risk assessment

Which use cases does this change impact?

How did/will you validate this change?

If something goes wrong after this change is released, what are the mitigation and rollback strategies?

How will you know if something goes wrong after this change is released?

Are there any special considerations for merging or releasing this change?

Merge / deployment checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

esbena left a comment

Choose a reason for hiding this comment

Uh oh!

esbena Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

esbena Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

esbena Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

esbena Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

esbena Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

esbena commented Mar 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mbg commented Feb 28, 2026 •

edited

Loading