Skip to content

Commit 9735752

Browse files
committed
Documents extension development and release process
Adds comprehensive sections to the README explaining how to build, compile, and package the extension. Details the steps for creating a new release, including GitHub Actions automation for VSIX generation and upload. Also updates the minimum required VS Code version.
1 parent 4900a60 commit 9735752

2 files changed

Lines changed: 71 additions & 1 deletion

File tree

.github/workflows/release.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Release VSIX
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
release:
9+
runs-on: ubuntu-latest
10+
11+
steps:
12+
- name: Checkout code
13+
uses: actions/checkout@v4
14+
15+
- name: Setup Node.js
16+
uses: actions/setup-node@v4
17+
with:
18+
node-version: '18'
19+
20+
- name: Setup pnpm
21+
uses: pnpm/action-setup@v4
22+
with:
23+
version: latest
24+
25+
- name: Install dependencies
26+
run: pnpm install
27+
28+
- name: Package extension
29+
run: pnpm run package
30+
31+
- name: Upload VSIX to release
32+
uses: softprops/action-gh-release@v2
33+
with:
34+
files: |
35+
*.vsix
36+
env:
37+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,40 @@ This extension contributes the following settings:
3434

3535
## Requirements
3636

37-
- VS Code 1.104.0 or later
37+
- VS Code 1.74.0 or later
38+
39+
## Development
40+
41+
### Building the Extension
42+
43+
```bash
44+
# Install dependencies
45+
pnpm install
46+
47+
# Compile the extension
48+
pnpm run compile
49+
50+
# Package for distribution
51+
pnpm run package
52+
```
53+
54+
### Releasing
55+
56+
To create a new release with a VSIX file:
57+
58+
1. Update the version in `package.json`
59+
2. Commit your changes
60+
3. Create a new GitHub release:
61+
- Go to GitHub → Releases → "Create a new release"
62+
- Create a new tag (e.g., `v0.0.3`)
63+
- Add release notes
64+
- Publish the release
65+
4. GitHub Actions will automatically:
66+
- Build the extension
67+
- Package it into a `.vsix` file
68+
- Upload the VSIX to the release assets
69+
70+
The VSIX file will be available for download from the GitHub release page and can be installed directly in VS Code.
3871

3972
## Release Notes
4073

0 commit comments

Comments
 (0)