Merge pull request #3186 from github/koesie10/generate-chromium-version

Rename update Chromium version script to generate Chromium version
This commit is contained in:
Koen Vlaswinkel
2024-01-05 09:49:34 +01:00
committed by GitHub
3 changed files with 6 additions and 19 deletions

View File

@@ -27,25 +27,11 @@ Also consider what percentage of our users are using each VS Code version. This
To provide a good experience to users, it is recommented to update the `MIN_VERSION` in `extension.ts` first and release, and then update the `vscode` version in `package.json` and release again.
By staggering this update across two releases it gives users on older VS Code versions a chance to upgrade before it silently refuses to upgrade them.
When updating the minimum version in `package.json`, you should also follow the additional steps listed below.
### Updating the Chromium target version
For the webview code, we use [esbuild](https://esbuild.github.io/) to bundle the code. This requires a target version of Chromium to be specified.
This version should be the same as the version of Chromium that is bundled with the new minimum VS Code version. To update
the version, run:
After updating the minimum version in `package.json`, make sure to also run the following command to update any generated
files dependent on this version:
```bash
npx ts-node scripts/update-chromium-version.ts
```
#### Troubleshooting
In case there's an error when specifying a version of Chromium, you may need to update the version of `caniuse-lite`
in `package.json` to a newer version. You should be able to do so by running:
```shell
npx update-browserslist-db@latest
npm run generate
```
## VS Code version used in tests

View File

@@ -1902,6 +1902,7 @@
"lint:scenarios": "ts-node scripts/lint-scenarios.ts",
"generate": "npm-run-all -p generate:*",
"generate:schemas": "ts-node scripts/generate-schemas.ts",
"generate:chromium-version": "ts-node scripts/generate-chromium-version.ts",
"check-types": "find . -type f -name \"tsconfig.json\" -not -path \"./node_modules/*\" | sed -r 's|/[^/]+$||' | sort | uniq | xargs -I {} sh -c \"echo Checking types in {} && cd {} && npx tsc --noEmit\"",
"postinstall": "patch-package",
"prepare": "cd ../.. && husky install"

View File

@@ -5,7 +5,7 @@ import { getVersionInformation } from "./util/vscode-versions";
const extensionDirectory = resolve(__dirname, "..");
async function updateChromiumVersion() {
async function generateChromiumVersion() {
const packageJson = await readJSON(
resolve(extensionDirectory, "package.json"),
);
@@ -36,7 +36,7 @@ async function updateChromiumVersion() {
);
}
updateChromiumVersion().catch((e: unknown) => {
generateChromiumVersion().catch((e: unknown) => {
console.error(e);
process.exit(2);
});