semantic-release-vsce

semantic-release-vsce

semantic-release plugin to package and publish VS Code extensions.

Step	Description
verify	Verify the presence and the validity of the authentication (set via environment variables) and the package.json
prepare	Generate the .vsix file using vsce, this can be be controlled by providing packageVsix in config. Note:- If the OVSX_PAT env variable is set, this step will still run
publish	Publish the extension

Install

npm install --save-dev semantic-release-vsce

OR

yarn add -D semantic-release-vsce

Usage

The plugin can be configured in the semantic-release configuration file:

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    ["semantic-release-vsce", {
        "packageVsix": true
    }],
    ["@semantic-release/github", {
      "assets": [
        {
          "path": "*.vsix",
          "label": "Extension File"
        },
      ]
    }],
  ]
}

Configuration

Option	Type	Description
packageVsix	boolean or string	If set to true, plugin will generate a .vsix file at the set file path after publishing. If is a string, it will be used as value for --out of vsce package. It is recommended to upload this to your GitHub release page so your users can easily rollback to an earlier version if a version ever introduces a bad bug.

Environment Variables

Variable	Description
VSCE_PAT	Required. The personal access token to publish the extension of VS Code Marketplace
OVSX_PAT	Optional The personal access token to push to OpenVSX

Publishing to OpenVSX

Publishing extensions to OpenVSX using this plugin is easy:

1. Get a valid personal access token with the correct privileges to the publisher namespace in OpenVSX. In order to get the personal access token, check this page.

2. Configure the OVSX_PAT environment variable in your CI with the token that you created.

3. Enjoy! The plugin will automatically detect the environment variable and it will publish to OpenVSX, no additional configuration is needed.

Working with older versions

This example is for semantic-release v15.
Prior to v15, prepare was part of publish - if you are using v14, you must pass the packageVsix option to publish instead.
Prior to v13, you had to override getLastRelease to use @semantic-release/git instead of the default @semantic-release/npm. This is no longer needed.

Travis example

Secret environment variables: VSCE_PAT

Example:

# .travis.yml

cache:
  directories:
    - ~/.npm

script:
  - npm test

stages:
  - test
  - name: release
    if: branch = master AND type = push AND fork = false

jobs:
  include:
    - stage: release
      language: node_js
      node_js: '10.18'
      script: npm run semantic-release

Github Actions Example

name: CD:- Release Extension

on:
  push:
    branches: [master]

jobs:
  Release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-node@v1
        with:
          node-version: 14
      - name: Install Node Dependencies
        run: npm ci
      - name: Generate Semantic Release
        run: yarn release
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          VSCE_PAT: ${{ secrets.VSCE_PAT }}