Title: Remove unnecessary check in `start-proxy-action-post` by mbg · Pull Request #4176 · github/codeql-action · GitHub
Open Graph Title: Remove unnecessary check in `start-proxy-action-post` by mbg · Pull Request #4176 · github/codeql-action
X Title: Remove unnecessary check in `start-proxy-action-post` by mbg · Pull Request #4176 · github/codeql-action
Description: 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.
Open Graph Description: 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 chec...
X Description: 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 chec...
Opengraph URL: https://github.com/github/codeql-action/pull/4176
X: @github
Domain: github.com
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf |
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:69e7c9e8-c0e6-6b2e-e585-bf3ae3c0de4e |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | 80EC:F1E2C:1E8EF:2927D:6AED2FF6 |
| html-safe-nonce | 152e5648103e1669d802820b9030d6937dd1be18958ca9d61def24cc2c82a91c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4MEVDOkYxRTJDOjFFOEVGOjI5MjdEOjZBRUQyRkY2IiwidmlzaXRvcl9pZCI6IjE4NTM4MjUxMTM1ODQ5MDYyMzAiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 67ec3385a5e92739448cfd2805bdf8a4636b205d2271993bbc1ad5a64f0420c2 |
| hovercard-subject-tag | pull_request:4638987286 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/github/codeql-action/pull/4176/files |
| twitter:image | https://avatars.githubusercontent.com/u/278086?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/278086?s=400&v=4 |
| og:image:alt | 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 chec... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | e51d0b7b5ab34b1688c05b54c3ed17b8658b2fa9bca973a9c740683ccb12cf4a |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/github/codeql-action git https://github.com/github/codeql-action.git |
| octolytics-dimension-user_id | 9919 |
| octolytics-dimension-user_login | github |
| octolytics-dimension-repository_id | 259445878 |
| octolytics-dimension-repository_nwo | github/codeql-action |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 259445878 |
| octolytics-dimension-repository_network_root_nwo | github/codeql-action |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 59ebb7b901cc154ecc179a44f266fcf69f343b30 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width