Report release version the proxy is taken from in `start-proxy` telemetry by mbg · Pull Request #4233 · github/codeql-action · GitHub

Extends start-proxy's success telemetry with the version of the release that the proxy binary came from.

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?

Workflow types:

Advanced setup - Impacts users who have custom CodeQL workflows.
Managed - Impacts users with dynamic workflows (Default Setup, Code Quality, ...).

Products:

Code Scanning - The changes impact analyses when analysis-kinds: code-scanning.
Code Quality - The changes impact analyses when analysis-kinds: code-quality.
Other first-party - The changes impact other first-party analyses.

Environments:

Dotcom - Impacts CodeQL workflows on github.com and/or GitHub Enterprise Cloud with Data Residency.

How did/will you validate this change?

Unit tests - I am depending on unit test coverage (i.e. tests in .test.ts files).
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?

Telemetry - I rely on existing telemetry or have made changes to the telemetry.
- Dashboards - I will watch relevant dashboards for issues after the release. Consider whether this requires this change to be released at a particular time rather than as part of a regular release.
- Alerts - New or existing monitors will trip if something goes wrong with this change.

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.

Warning

Copilot's review of this pull request may be incomplete because some of the changed files are excluded by your Copilot content exclusion settings. See Excluding content from Copilot for details.

🟡 Changes recommended

The primary telemetry payload lacks direct unit-test coverage for its field name and nesting.

1 open finding

Add unit test verifying proxy version telemetry payload · New

What changed in this PR

Adds the originating proxy release version to successful start-proxy telemetry.

Changes:

Returns both the proxy path and version.
Adds start_proxy.proxy_version to telemetry.
Extracts proxy status reporting and updates tests.

File	Description
src/start-proxy/status-report.ts	Defines proxy telemetry and reporting.
src/start-proxy/status-report.test.ts	Relocates failure-report tests.
src/start-proxy.ts	Returns proxy path and version.
src/start-proxy.test.ts	Verifies resolved proxy versions.
src/start-proxy-action.ts	Sends the version in success telemetry.
lib/entry-points.js	Generated bundle; content excluded from review.

Files excluded by content exclusion policy (1)

lib/entry-points.js

🧠 Review effort: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

…t-version

Would calledOnceWithExactly work here?

Yeah, but I don't like the sinon assertions because they only return true/false and so if the assertion fails we don't know why. The t.like will print a nice diff if the assertion fails.

I think if we use sinon.assert.calledOnceWithExactly instead of sendStatusReport.calledOnceWithExactly we'll get a good error message if the assertion fails. It's non-blocking, though.

mbg added 3 commits October 13, 2026 18:59

Move start-proxy status report handling into its own file

aa80ca0

Return release version from getProxyBinaryPath

6308e36

Include proxy version in telemetry

43db2c0

mbg requested a review from a team as a code owner October 13, 2026 18:14

Copilot AI balanced review requested due to automatic review settings October 13, 2026 18:14

github-actions Bot added the size/L May be hard to review label Oct 13, 2026

Copilot started reviewing on behalf of mbg October 13, 2026 18:14

View session

Copilot AI reviewed Oct 13, 2026

View reviewed changes

Comment thread src/start-proxy/status-report.ts

mbg added 3 commits October 14, 2026 10:30

Sort registry_types in status report

6aee1f8

Add unit test for sendSuccessStatusReport

1580058

Merge remote-tracking branch 'origin/main' into mbg/start-proxy/repor…

4eabea6

…t-version

henrymercer previously approved these changes Oct 15, 2026

View reviewed changes

Rename path to result in tests

8dec0b9

mbg dismissed henrymercer’s stale review via 8dec0b9 October 15, 2026 10:03

mbg requested a review from henrymercer October 15, 2026 10:05

henrymercer approved these changes Oct 15, 2026

View reviewed changes

mbg enabled auto-merge October 15, 2026 10:06

mbg added this pull request to the merge queue Oct 15, 2026

Merged via the queue into main with commit d63383a Oct 15, 2026
234 checks passed

mbg deleted the mbg/start-proxy/report-version branch October 15, 2026 10:29

This was referenced Oct 15, 2026

Merge main into releases/v4 #4239

Merged

Merge releases/v4 into releases/v3 #4241

Merged

+                t.is(sendStatusReport.callCount, 1);
+                t.is(sendStatusReport.args[0].length, 1);
+                const arg = sendStatusReport.args[0][0];
+                t.like(arg, {
+                  action_name: statusReport.ActionName.StartProxy,
+                  registry_types: "docker_registry,git_source",
+                  start_proxy: { proxy_version },
+                });

Report release version the proxy is taken from in `start-proxy` telemetry by mbg · Pull Request #4233 · github/codeql-action · GitHub

Repository navigation

Report release version the proxy is taken from in start-proxy telemetry - #4233

Report release version the proxy is taken from in start-proxy telemetry#4233
mbg merged 7 commits into
mainfrom
mbg/start-proxy/report-version

mbg commented Oct 13, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

henrymercer Oct 15, 2026

Uh oh!

mbg Oct 15, 2026

Uh oh!

henrymercer Oct 15, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Report release version the proxy is taken from in `start-proxy` telemetry by mbg · Pull Request #4233 · github/codeql-action · GitHub

Repository navigation

Report release version the proxy is taken from in start-proxy telemetry - #4233

Report release version the proxy is taken from in start-proxy telemetry#4233mbg merged 7 commits intomaingithub/codeql-action:mainfrom mbg/start-proxy/report-versiongithub/codeql-action:mbg/start-proxy/report-versionCopy head branch name to clipboard

Conversation

mbg commented Oct 13, 2026

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

🟡 Changes recommended

Uh oh!

Uh oh!

henrymercer Oct 15, 2026

Choose a reason for hiding this comment

Uh oh!

mbg Oct 15, 2026

Choose a reason for hiding this comment

Uh oh!

henrymercer Oct 15, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Report release version the proxy is taken from in start-proxy telemetry#4233
mbg merged 7 commits into
mainfrom
mbg/start-proxy/report-version