diff --git a/README.md b/README.md index 1324be8..8aae250 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,35 @@ npm ci npm run update ``` +# Publishing + +To publish + +1. Bump the package version and tag. + + The easiest way is `npm version patch` + +2. Push the patch + + ``` + git push --tag origin main + ``` + +3. Wait for github actions to successfully build all the versions + +4. Run `npm run publish` + + This will download the files from the latest release to the `dist` folder + and then publish them. + + Step 4 assumes you've gone through steps [here](https://code.visualstudio.com/api/working-with-extensions/publishing-extension), setup an Azure account, created an organization, created a personal access token, and logged in from the command line. You can log in with + + ``` + npm run login + ``` + + Then run `npm run publish` + # Building This builds for the local OS (win64,macOS-arm,linux) diff --git a/package.json b/package.json index b787ce2..3607649 100644 --- a/package.json +++ b/package.json @@ -6,12 +6,13 @@ "type": "module", "scripts": { "build": "node build/build.js", + "login": "vsce login", "publish": "node build/publish.js", "update": "node build/update.js" }, "repository": { "type": "git", - "url": "git+https://github.com/greggman/tintd.git" + "url": "git+https://github.com/greggman/tintd-builder.git" }, "keywords": [ "WGSL", @@ -21,9 +22,9 @@ "author": "", "license": "MIT", "bugs": { - "url": "https://github.com/greggman/tintd/issues" + "url": "https://github.com/greggman/tintd-builder/issues" }, - "homepage": "https://github.com/greggman/tintd#readme", + "homepage": "https://github.com/greggman/tintd-builder#readme", "devDependencies": { "@vscode/vsce": "^2.26.1", "octokit": "^4.0.2"