Skip to content

Remove unnecessary check in start-proxy-action-post - #4176

Merged
mbg merged 2 commits into
mainfrom
mbg/start-proxy/improve-post-githubversion-logic
Sep 25, 2026
Merged

mbg merged 2 commits into
mainfrom
mbg/start-proxy/improve-post-githubversion-logic

Conversation

@mbg

@mbg mbg commented Sep 25, 2026

Copy link
Copy Markdown
Member

The init step only saves the configuration at the end if otherwise successful, so a failure before that point will mean that no configuration is written to disk. The config?.gitHubVersion.type check in the start-proxy post step will therefore fail and exit after logging "Did not upload debug artifacts because cannot determine the GitHub variant running." and before uploading the proxy log as an artifact.

That's not desirable, because the proxy log may contain information that is relevant to troubleshooting why the init step failed. Furthermore, we don't depend on the gitHubVersion from the config in any case, since we call getGitHubVersion immediately afterwards and use the result of that.

The check was introduced originally in #2482. This PR deletes the config?.gitHubVersion.type check so that proxy logs can be uploaded as artifacts when we are in debug mode even if the init step fails.

As a drive-by improvement, I have also modified getGitHubVersion so that getApiDetails() isn't called twice (once directly and once indirectly by getApiClient).

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:

  • 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.
  • GHES - Impacts CodeQL workflows on GitHub Enterprise Server.

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.

@mbg
mbg requested review from henrymercer and a balanced review from Copilot September 25, 2026 14:14
@mbg
mbg requested a review from a team as a code owner September 25, 2026 14:14
@github-actions github-actions Bot added the size/XS Should be very easy to review label Sep 25, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot review overview

🟡 Changes recommended

The newly enabled missing-configuration upload path needs regression test coverage.

Get a fresh assessment by requesting another Copilot review.

Review effort: Balanced
Findings: 1 Low severity

Open (1)
What changed in this PR

Enables proxy-log uploads when initialization fails before writing configuration.

Changes:

  • Removes the configuration-based upload guard.
  • Reuses API details when creating the GitHub client.
File Description
src/​start-proxy-action-post.ts Allows debug proxy-log uploads without saved configuration.
src/​api-client.ts Avoids retrieving API details twice.
lib/​entry-points.js Generated bundle excluded from review by policy.
Files excluded by content exclusion policy (1)
  • lib/entry-points.js

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

Comment thread src/start-proxy-action-post.ts
@mbg
mbg added this pull request to the merge queue Sep 25, 2026
Merged via the queue into main with commit fa2bea7 Sep 25, 2026
242 checks passed
@mbg
mbg deleted the mbg/start-proxy/improve-post-githubversion-logic branch September 25, 2026 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Should be very easy to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants