Title: Add repository property for `tools` input by mbg · Pull Request #4037 · github/codeql-action · GitHub
Open Graph Title: Add repository property for `tools` input by mbg · Pull Request #4037 · github/codeql-action
X Title: Add repository property for `tools` input by mbg · Pull Request #4037 · github/codeql-action
Description: This PR attempts to simplify and tidy up #3766 while resolving conflicts with recent changes to the codebase. Compared with #3766, there are the following changes: The repository property's behaviour is gated by a new FF. There is no github-codeql-tools-mode property. The justification for this is that in Advanced Setup workflows, the tools input provided in the workflow takes precedence. The value of the repository property can be enforced with a prefix !. This is similar to the + notation for the queries input, where + means "combine rather than replace". This PR does not change the telemetry to include the source of the effective tools value. However, it does lay the groundwork for it with the EffectiveInput type and getToolsInput returns a suitable value. Once we have merged relevant backend changes, the intention is to then make use of EffectiveInput values in the status reports. This will avoid duplication of work across similar inputs (i.e. rather than adding several new status reports properties for each, we will have an array of EffectiveInput values). That's outside the scope of this PR though. Like #3766, this PR also updates setup-codeql to load the repository properties. Since the loaded values are not persisted, this means that both setup-codeql and init could load them. However, we don't yet allow setup-codeql in the same workflow as init, so this is not an issue right now. If we allow setup-codeql before init in the future, we will need to review potentially duplicated work across both steps in any case. 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. 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? Feature flags - All new or changed code paths can be fully disabled with corresponding feature flags. 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: This PR attempts to simplify and tidy up #3766 while resolving conflicts with recent changes to the codebase. Compared with #3766, there are the following changes: The repository property's be...
X Description: This PR attempts to simplify and tidy up #3766 while resolving conflicts with recent changes to the codebase. Compared with #3766, there are the following changes: The repository property'...
Opengraph URL: https://github.com/github/codeql-action/pull/4037
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:a14b4280-68ac-1dc5-3910-813dffee8457 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | C8FE:7C3DA:38B37B:4D37F0:6AED4F4A |
| html-safe-nonce | 4e22d3ceb68e66f1a7b35f77bd01fcf92d1896367d9f8930ad681cf6b3b4cd56 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDOEZFOjdDM0RBOjM4QjM3Qjo0RDM3RjA6NkFFRDRGNEEiLCJ2aXNpdG9yX2lkIjoiNDIxMDQwMzE0OTgzMjA4MTIyNiIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 01c3fafc53d54e0c4801426f13d8e961e5369aa6188e5f99d9173e4e89d707b9 |
| hovercard-subject-tag | pull_request:4108639294 |
| 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/4037/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 | This PR attempts to simplify and tidy up #3766 while resolving conflicts with recent changes to the codebase. Compared with #3766, there are the following changes: The repository property's be... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 56fb42677ae87ed3e64410323d67980aa65d0485568a7858f874e7edfc6d1c11 |
| 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 | 9c9a37e2423ed382cf39f70b5aa4b4858b40a3b0 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width