Skip to content

PUBLISHING.md

Latest commit

 

History

History
137 lines (99 loc) · 3.28 KB

PUBLISHING.md

File metadata and controls

137 lines (99 loc) · 3.28 KB

Publishing Checklist

Note: This project now uses GitHub Actions for automated publishing. See DEPLOYMENT.md for automated deployment setup. The manual steps below are still valid if you prefer to publish manually.

✅ Pre-Publishing Requirements

Required Files

  • package.json - Complete with all required fields
  • README.md - Comprehensive documentation
  • CHANGELOG.md - Version history
  • LICENSE - MIT License
  • icon.png - 128x128px in images/ folder
  • .vscodeignore - Excludes unnecessary files

package.json Requirements

  • name - Unique identifier
  • displayName - Human-readable name
  • description - Clear description
  • version - Semantic version (1.0.0)
  • publisher - Publisher ID (alckordev)
  • engines.vscode - Minimum VS Code version
  • icon - Path to icon file
  • repository - GitHub repository URL
  • bugs - Issues URL
  • homepage - Homepage URL
  • categories - Extension category
  • keywords - Search keywords
  • main - Entry point (./out/extension.js)

Code Quality

  • TypeScript compiles without errors
  • ESLint passes without errors
  • All imports resolve correctly
  • Extension activates correctly
  • All commands work as expected

Testing

  • Extension loads in Extension Development Host
  • Scripts display correctly in sidebar
  • Script execution works
  • Package manager detection works
  • Multi-workspace support works
  • File watcher updates correctly

📦 Publishing Steps

1. Install VSCE (VS Code Extension Manager)

npm install -g @vscode/vsce

2. Create Azure DevOps Publisher

  1. Go to https://marketplace.visualstudio.com/manage
  2. Sign in with Microsoft account
  3. Create new publisher with ID: alckordev
  4. Verify publisher ID matches package.json

3. Generate Personal Access Token (PAT)

  1. Go to Azure DevOps → User Settings → Personal Access Tokens
  2. Create new token with scope: Marketplace (Manage)
  3. Save the token securely

4. Login to VSCE

vsce login alckordev
# Enter your PAT when prompted

5. Package Extension

# From project root
vsce package

This creates quick-scripts-runner-1.0.0.vsix

6. Test Package Locally (Optional)

code --install-extension quick-scripts-runner-1.0.0.vsix

7. Publish to Marketplace

vsce publish

Or publish with version increment:

vsce publish minor  # 1.0.0 -> 1.1.0
vsce publish patch  # 1.0.0 -> 1.0.1

⚠️ Important Notes

  • Publisher ID: Must match exactly in package.json and Azure DevOps
  • Version: Must follow semantic versioning (major.minor.patch)
  • Repository: Must be publicly accessible
  • Icon: Must be exactly 128x128px PNG
  • CHANGELOG: Should have real dates (not placeholders)

🔍 Pre-Publish Verification

Run these commands to verify everything:

# Compile
pnpm run compile

# Lint
pnpm run lint

# Package (dry run)
vsce package --no-yarn

# Check package contents
vsce ls

📝 Post-Publishing

  1. Verify extension appears in Marketplace
  2. Test installation from Marketplace
  3. Monitor reviews and issues
  4. Update CHANGELOG.md for future releases
  5. Update version in package.json for next release