Skip to content

PUBLISHING_CHECKLIST.md

Latest commit

 

History

History
105 lines (82 loc) · 3.02 KB

PUBLISHING_CHECKLIST.md

File metadata and controls

105 lines (82 loc) · 3.02 KB
Raw

Publishing Checklist

Use this checklist before publishing PolyForm to the VS Code Marketplace.

Pre-Publishing Checklist

1. Code Quality

  • All TypeScript compilation errors fixed
  • No ESLint warnings
  • Code is properly formatted
  • All features tested locally

2. Documentation

  • README.md is complete with screenshots
  • ARCHITECTURE.md explains technical details
  • ENVIRONMENT_DETECTION.md documents environment setup
  • CHANGELOG.md lists all changes
  • LICENSE file exists (MIT)
  • Add screenshots/GIFs to README

3. Package Metadata

  • package.json has all required fields
  • Version number is correct (0.1.0)
  • Publisher ID matches your account
  • Keywords are relevant
  • Categories are appropriate
  • Icon is 512x512px PNG
  • Repository URL is correct

4. Files

  • .gitignore excludes build artifacts
  • icon.png exists in root
  • LICENSE file exists
  • CHANGELOG.md exists
  • Remove any test/debug files

5. Build & Test

  • Run npm run compile successfully
  • Run npm run package successfully
  • Test the packaged .vsix file locally
  • Verify extension loads in clean VS Code instance
  • Test code execution for both Python and JavaScript
  • Test virtual environment detection

6. Marketplace Setup

  • Create Microsoft account (if needed)
  • Create Azure DevOps organization
  • Create publisher account (hridesh-net)
  • Generate Personal Access Token (PAT)
  • Login with vsce login hridesh-net

7. Publishing

  • Run vsce package to create .vsix
  • Test .vsix installation locally
  • Run vsce publish to publish
  • Verify extension appears on marketplace
  • Install from marketplace to test

8. Post-Publishing

  • Create GitHub release with tag (v0.1.0)
  • Update repository README with marketplace badge
  • Share on social media / developer communities
  • Monitor for issues and feedback

Quick Commands

# Install vsce globally
npm install -g @vscode/vsce

# Login to publisher account
vsce login hridesh-net

# Package extension
vsce package

# Test locally
code --install-extension polyform-0.1.0.vsix

# Publish to marketplace
vsce publish

# Or publish with version bump
vsce publish patch  # 0.1.0 → 0.1.1
vsce publish minor  # 0.1.0 → 0.2.0
vsce publish major  # 0.1.0 → 1.0.0

Important Notes

  • Publisher ID: Must match exactly in package.json and marketplace
  • Icon: Must be named icon.png and be at least 128x128px (512x512 recommended)
  • Version: Follow semantic versioning (MAJOR.MINOR.PATCH)
  • Repository: Must be publicly accessible
  • Testing: Always test .vsix locally before publishing

Resources

Ready to publish? Complete this checklist and run vsce publish! 🚀