Skip to content

Commit 70b6fd5

Browse files
committed
chore: add release guide to vscode and cursor
1 parent 15eb00d commit 70b6fd5

1 file changed

Lines changed: 43 additions & 0 deletions

File tree

CONTRIBUTION.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,46 @@ How to build and test the extension:
55
- Run `npm install` to install deps;
66
- Run `npm run watch`;
77
- Press F5 to run extension.
8+
9+
## Release Process
10+
11+
To publish a new version of the extension to both the VS Code Marketplace and the Open VSX Registry (which Cursor uses):
12+
13+
1. **Bump Version:**
14+
Run the release script to bump the version in `package.json`, update `CHANGELOG.md`, and create a release commit/tag:
15+
```bash
16+
npm run release
17+
```
18+
19+
2. **Push Changes:**
20+
Push the commit and tags to the repository:
21+
```bash
22+
git push --follow-tags origin master
23+
```
24+
25+
3. **Package the Extension:**
26+
To ensure the exact same build is published to both registries, package the extension into a `.vsix` file first:
27+
```bash
28+
vsce package
29+
```
30+
*This will generate a file named `vscode-testplane-<version>.vsix` (e.g., `vscode-testplane-1.3.1.vsix`).*
31+
32+
4. **Publish to VS Code Marketplace:**
33+
Ensure you have the `@vscode/vsce` CLI installed (`npm i -g @vscode/vsce`). You need a valid publisher Personal Access Token (can be created in Azure DevOps).
34+
```bash
35+
# Login if you haven't already
36+
vsce login gemini-testing
37+
38+
# Publish the packaged extension
39+
vsce publish vscode-testplane-<version>.vsix
40+
```
41+
42+
5. **Publish to Open VSX (For Cursor):**
43+
Cursor relies on the Open VSX registry for extensions. Ensure you have the `ovsx` CLI installed (`npm i -g ovsx`).
44+
45+
**Token Setup:** You need a valid Open VSX access token. You can generate one by logging into [open-vsx.org](https://open-vsx.org/), navigating to your **Settings**, and creating a new token under **Access Tokens**.
46+
47+
```bash
48+
# Assuming you have set OVSX_PAT as an environment variable
49+
ovsx publish vscode-testplane-<version>.vsix -p $OVSX_PAT
50+
```

0 commit comments

Comments
 (0)