template-vscode-extension

Template for creating Visual Studio Code extension with preconfigured GitHub workflows.

How to set up your new repository

1. Click here to use this template to create a new repository
2. Wait until the repository preparation is done
   • Click here to check the progress of the workflow
3. Click here to create a LICENSE file
4. Create 2 new environments: production and prerelease
   1. Click here to create a new environment named production and prerelease respectively
   2. Add an environment secret named VSCE_PAT
   3. Paste your personal access token
      • Follow this article to create a personal access token
      • For permissions, make sure "Marketplace" > "Publish" is checked.
   4. (Optional) Protect your production environment by requiring approvals from collaborators

How to publish

To publish, you need to push a tag that is corresponding to the version you want to publish. If you want to publish 0.0.1, push a tag v0.0.1 to your repository.

You can follow our steps:

• Assumptions
  • Your current version is 0.0.1-0 (pre-release of 0.0.1)
  • You want to release 0.0.1
• Steps to release
  • git log and make sure you are on the commit you want to publish as 0.0.1
  • npm version 0.0.1
  • git push -u origin v0.0.1, this will trigger publish
• Post-release steps
  • It is highly recommended to bump to 0.0.2-0 immediately after 0.0.1 is published
  • git checkout -b bump-0.0.2-0 to create a new branch for pull request
  • npm version --no-git-tag-version prepatch, this will bump to 0.0.2-0
  • git commit -a -m "0.0.2-0"
  • git push -u origin bump-0.0.2-0
  • gh pr create, to create a pull request

Contributions

Like us? Star us.

Want to make it better? File us an issue.

Don't like something you see? Submit a pull request.