Title: Avoid bundling `package.json` in JavaScript files by mbg · Pull Request #3573 · github/codeql-action · GitHub
Open Graph Title: Avoid bundling `package.json` in JavaScript files by mbg · Pull Request #3573 · github/codeql-action
X Title: Avoid bundling `package.json` in JavaScript files by mbg · Pull Request #3573 · github/codeql-action
Description: Currently, we bundle the entire contents of package.json in our generated JavaScript files. This is because we depend on the "version" property in actions-util.ts. This PR changes this so that we load package.json in build.mjs, retrieve the version, and use it to define a constant named __CODEQL_ACTION_VERSION__ that's available to the bundled code instead. Therefore, we no longer depend on package.json, and esbuild omits it. To allow the tests to continue functioning (which don't go through the build process first), an equivalent change for ava now runs ava.setup.mjs before tests which also loads package.json and sets __CODEQL_ACTION_VERSION__ to the version value. 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. Third-party analyses - The changes affect the upload-sarif action. 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: Currently, we bundle the entire contents of package.json in our generated JavaScript files. This is because we depend on the "version" property in actions-util.ts. This PR changes this so...
X Description: Currently, we bundle the entire contents of package.json in our generated JavaScript files. This is because we depend on the "version" property in actions-util.ts. This PR changes...
Opengraph URL: https://github.com/github/codeql-action/pull/3573
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:bcd43817-1f9e-7046-ec8f-f98ebc741a6d |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | 8AA8:1AC56:10235FE:1591979:6A4C5853 |
| html-safe-nonce | 4a5722a0aba1f2b017a9322f6692f28ed6e385888ea5b043276479fd367a7d43 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4QUE4OjFBQzU2OjEwMjM1RkU6MTU5MTk3OTo2QTRDNTg1MyIsInZpc2l0b3JfaWQiOiI3OTgxMTYxMzc2NTgzMDE0NDgzIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | ee2ba31b71bbae60d4078cc958be37c5f0e8b4d1310588c7de49fa820a87f48f |
| hovercard-subject-tag | pull_request:3391303087 |
| 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/3573/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 | Currently, we bundle the entire contents of package.json in our generated JavaScript files. This is because we depend on the "version" property in actions-util.ts. This PR changes this so... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 3d11bb817438277de2a940854450e83a7d32b6aeb5014e9e6b00a6423900251c |
| 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 | 14099438da5379150f15a2892474c7c7e6c0e55e |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width