Skip to content

Commit

Permalink
Updated package / publish scripts + corresponding docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bmingles committed Nov 1, 2024
1 parent d75be71 commit 451ad80
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Download one from the [releases/](releases/) folder.

or

Build a .vsix locally via `npm run package`
Build a .vsix locally via `npm run package:latest`

Then install in vscode:
![Install Deephaven in VS Code](docs/install.png)
Expand Down Expand Up @@ -86,16 +86,16 @@ https://code.visualstudio.com/api/working-with-extensions/publishing-extension#p
1. Increment the version number in `package.json` (be sure to run `npm i` to update package-lock as well)
> See [versioning strategy](#versioning-strategy) for details on our version number scheme.
1. If new content has been added that needs to be packaged that is not included by `.vscodeignore`, make appropriate changes (this should not be common).
1. Package latest `npm run vsix:latest` (inspect output to verify included files are as expected)
1. Package latest `npm run package:latest` (inspect output to verify included files are as expected)
1. Use `vsce` cli to publish to Visual Studio Marketplace
```sh
# Pre-release
npm run publish:pre
npm run publish:prerelease
```
1. Create a version tag with `-pre` suffix.
```sh
npm run vscode:tag
npm run publish:tag
git push --tags
```
Expand Down
9 changes: 4 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@
"clean": "rm -rf out packages/*/tsconfig.tsbuildinfo",
"compile": "npm run check:types && node scripts/esbuild.js",
"icon:gen": "node icons/generate.mjs",
"package": "npm run check:types && npm run test:lint && node scripts/esbuild.js --production",
"publish:pre": "vsce publish --pre-release",
"package:latest": "vsce package -o releases/vscode-deephaven-latest.vsix",
"publish:prerelease": "vsce publish --pre-release",
"publish:tag": "git tag v$(node -p -e \"require('./package.json').version\")-pre",
"report:ctrfmerge": "ctrf merge e2e/reports --keep-reports --output-dir test-reports --output ctrf-report.json",
"report:ctrfsummary": "github-actions-ctrf test-reports/ctrf-report.json",
"report:junit2ctrf": "junit-to-ctrf test-reports/vitest.junit.xml --output test-reports/ctrf-report.json",
Expand All @@ -44,9 +45,7 @@
"test:lint": "eslint . --ext ts",
"test:unit": "vitest --reporter=default --reporter=junit --outputFile=./test-reports/vitest.junit.xml",
"test": "npm run test:unit",
"vscode:prepublish": "npm run package",
"vscode:tag": "git tag v$(node -p -e \"require('./package.json').version\")-pre",
"vsix:latest": "vsce package -o releases/vscode-deephaven-latest.vsix",
"vscode:prepublish": "npm run check:types && npm run test:lint && node scripts/esbuild.js --production",
"watch:esbuild": "node scripts/esbuild.js --watch",
"watch:tsc": "npm run clean && tsc --build ./tsconfig.json --watch",
"watch": "npm-run-all -p watch:*"
Expand Down

0 comments on commit 451ad80

Please sign in to comment.