Skip to content

Commit 5a3abcf

Browse files
committed
docs(publish): add publishing instructions for extension
Add PUBLISH.md with steps and guidelines for publishing the VSCode extension.
1 parent d3de8fa commit 5a3abcf

File tree

1 file changed

+142
-0
lines changed

1 file changed

+142
-0
lines changed

mpp-vscode/PUBLISH.md

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
# AutoDev VSCode Extension - Publishing Guide
2+
3+
## 📦 Package Information
4+
5+
- **Extension ID**: `Phodal.autodev`
6+
- **Version**: 0.5.3
7+
- **Package File**: `autodev-0.5.3.vsix` (3.11 MB)
8+
- **Dependencies**: Uses published npm packages
9+
- `@autodev/[email protected]`
10+
- `@autodev/[email protected]`
11+
12+
## ✅ Pre-publish Checklist
13+
14+
All steps completed:
15+
- [x] Version updated in `gradle.properties` (0.3.4)
16+
- [x] mpp-core built and published to npm
17+
- [x] mpp-ui (CLI) built and published to npm
18+
- [x] mpp-vscode updated to use published mpp-core
19+
- [x] Extension built successfully
20+
- [x] Extension packaged as VSIX (3.11 MB)
21+
- [x] Changes committed and pushed to GitHub
22+
23+
## 🚀 Publishing to VS Code Marketplace
24+
25+
### Option 1: Using vsce CLI (Recommended)
26+
27+
1. **Get Personal Access Token (PAT)**
28+
- Go to https://dev.azure.com/
29+
- Create a new PAT with `Marketplace (Publish)` scope
30+
- Save the token securely
31+
32+
2. **Publish**
33+
```bash
34+
cd /Volumes/source/ai/autocrud/mpp-vscode
35+
vsce publish
36+
# When prompted, enter your PAT
37+
```
38+
39+
3. **Or publish with explicit PAT**
40+
```bash
41+
vsce publish -p <YOUR_PAT>
42+
```
43+
44+
### Option 2: Manual Upload via Web
45+
46+
1. Go to https://marketplace.visualstudio.com/manage/publishers/Phodal
47+
2. Click "New Extension"
48+
3. Upload `autodev-0.5.3.vsix`
49+
4. Fill in the marketplace details
50+
5. Publish
51+
52+
## 📝 First-Time Publisher Setup
53+
54+
If this is your first time publishing as "Phodal":
55+
56+
1. **Create Publisher**
57+
```bash
58+
vsce create-publisher Phodal
59+
```
60+
61+
2. **Login**
62+
```bash
63+
vsce login Phodal
64+
# Enter your PAT when prompted
65+
```
66+
67+
## 🔍 Verify Installation
68+
69+
After publishing, test the extension:
70+
71+
```bash
72+
# Install from marketplace
73+
code --install-extension Phodal.autodev
74+
75+
# Or install from local VSIX (for testing)
76+
code --install-extension autodev-0.5.3.vsix
77+
```
78+
79+
## 📊 What's Included in the Package
80+
81+
The VSIX contains:
82+
- Extension code (13.6 MB - bundled with esbuild)
83+
- Webview assets (374 KB - React UI)
84+
- Tree-sitter WASM files (10.74 MB - 8 languages)
85+
- Media assets (icons, fonts)
86+
- DevIns language syntax
87+
- Test mocks
88+
89+
**Total package size**: 3.11 MB (compressed)
90+
91+
## 🔄 Updating the Extension
92+
93+
For future updates:
94+
95+
1. Update version in `gradle.properties`
96+
2. Build and publish mpp-core if needed
97+
3. Update mpp-vscode/package.json dependency versions
98+
4. Run `npm run build`
99+
5. Run `vsce package`
100+
6. Run `vsce publish` or upload manually
101+
102+
## 📖 Marketplace Listing
103+
104+
**Display Name**: AutoDev - 🧙the AI-powered coding wizard (KMP Edition).
105+
106+
**Description**:
107+
> 🧙‍ AI-powered coding wizard with multilingual support 🌐, auto code generation 🏗️, based on Kotlin Multiplatform. AutoDev provides CodeLens, Chat, and powerful agent features! 🚀
108+
109+
**Categories**:
110+
- Programming Languages
111+
- Education
112+
- Machine Learning
113+
- Snippets
114+
115+
**Keywords**: ai, coding assistant, llm, autodev, kotlin multiplatform, kmp
116+
117+
## 🔗 Links
118+
119+
- Homepage: https://vscode.unitmesh.cc
120+
- Repository: https://github.com/unit-mesh/auto-dev-vscode
121+
- Issues: https://github.com/unit-mesh/auto-dev-vscode/issues
122+
- Marketplace: https://marketplace.visualstudio.com/items?itemName=Phodal.autodev
123+
124+
## ⚠️ Important Notes
125+
126+
1. **Same Publisher ID**: This extension uses `Phodal` as publisher, matching the existing AutoDev extension
127+
2. **Version Coordination**: mpp-core (0.3.4) and CLI (0.3.4) are published separately
128+
3. **File Size**: Extension is 3.11 MB compressed (includes WASM files for Tree-sitter)
129+
4. **Minimum VSCode**: Requires VSCode 1.85.0 or higher
130+
131+
## 🎯 Next Steps
132+
133+
1. Execute: `vsce publish` in the mpp-vscode directory
134+
2. Wait for marketplace processing (usually 5-10 minutes)
135+
3. Verify extension appears in marketplace
136+
4. Test installation and functionality
137+
5. Announce the release!
138+
139+
---
140+
141+
**Ready to publish!** 🚀
142+

0 commit comments

Comments
 (0)