semantic-release-vsce 5.0.8 → 5.0.11

package/.github/workflows/ci.yaml

@@ -21,7 +21,7 @@ jobs:
           - 16
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: volta-cli/action@v1
         with:
           node-version: ${{ matrix.node-version }}
@@ -34,7 +34,7 @@ jobs:
     needs: test
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: volta-cli/action@v1
       - run: npm ci
       - run: npm run release

package/README.md

@@ -9,43 +9,62 @@
 [![peerDependencies](https://david-dm.org/felipecrs/semantic-release-vsce/peer-status.svg)](https://david-dm.org/felipecrs/semantic-release-vsce?type=peer)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-#### Add config to package.json
+| Step               | Description                                                                                                                                                                                                                              |
+|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `verify` | Verify the presence and the validity of the authentication (set via [environment variables](#environment-variables)) and the `package.json`|
+| `prepare` | Generate the `.vsix` file using vsce, this can be be controlled by providing `packageVsix` in config. <br/> *Note:- If the `OVSX_PAT` env variable is set, this step will still run*|
+| `publish` | Publish the extension|
 
-Use `semantic-release-vsce` as part of `verifyConditions` and `publish`.
+## Install
+
+```bash
+npm install --save-dev semantic-release-vsce
+```
+
+OR
+
+```bash
+yarn add -D semantic-release-vsce
+```
+
+## Usage
+
+The plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):
 
 ```json
 {
-  "scripts": {
-    "semantic-release": "semantic-release"
-  },
-  "release": {
-    "verifyConditions": [
-      "semantic-release-vsce",
-      "@semantic-release/github"
-    ],
-    "prepare": {
-      "path": "semantic-release-vsce",
-      "packageVsix": true
-    },
-    "publish": [
-      "semantic-release-vsce",
-      {
-        "path": "@semantic-release/github",
-        "assets": "*.vsix"
-      }
-    ]
-  },
-  "devDependencies": {
-    "semantic-release": "^17.0.0",
-    "semantic-release-vsce": "^2.1.0",
-  }
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    ["semantic-release-vsce", {
+        "packageVsix": true
+    }],
+    ["@semantic-release/github", {
+      "assets": [
+        {
+          "path": "*.vsix",
+          "label": "Extension File"
+        },
+      ]
+    }],
+  ]
 }
 ```
 
-If `packageVsix` is set, will also 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. 
+## 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`. <br /> 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
 
-#### Publishing to OpenVSX
+| 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:
 
@@ -55,13 +74,13 @@ Publishing extensions to OpenVSX using this plugin is easy:
 
 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
+### 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
+### Travis example
 
 Secret environment variables: `VSCE_PAT`
 
@@ -89,3 +108,29 @@ jobs:
       node_js: '10.18'
       script: npm run semantic-release
 ```
+
+### Github Actions Example
+
+```yaml
+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 }}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semantic-release-vsce",
-  "version": "5.0.8",
+  "version": "5.0.11",
   "description": "semantic-release plugin to package and publish VS Code extensions",
   "license": "MIT",
   "engines": {