semantic-release-vsce 5.3.0 → 5.5.0

package/README.md

@@ -90,11 +90,11 @@ Which `.vsix` file (or files) to publish. This controls what value will be used
 
 ### Environment variables
 
-| Variable      | Description                                                                                                                                                                                            |
-| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `VSCE_PAT`    | **Required** (unless `publish` is set to `false`). The personal access token to publish the extension to Visual Studio Marketplace                                                                     |
-| `VSCE_TARGET` | _Optional_. The target to use when packaging or publishing the extension (used as `vsce package --target ${VSCE_TARGET}`). See [the platform-specific example](#platform-specific-on-github-actions) ) |
-| `OVSX_PAT`    | _Optional_. The personal access token to push to OpenVSX                                                                                                                                               |
+| Variable      | Description                                                                                                                                                                                                                                                                                                     |
+| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `VSCE_PAT`    | **Required** (unless `publish` is set to `false`). The personal access token to publish the extension to Visual Studio Marketplace                                                                                                                                                                              |
+| `VSCE_TARGET` | _Optional_. The target to use when packaging or publishing the extension (used as `vsce package --target ${VSCE_TARGET}`). When set to `universal`, behave as if `VSCE_TARGET` was not set (i.e. build the universal/generic `vsix`). See [the platform-specific example](#platform-specific-on-github-actions) |
+| `OVSX_PAT`    | _Optional_. The personal access token to push to OpenVSX                                                                                                                                                                                                                                                        |
 
 ### Publishing to OpenVSX
 
@@ -178,13 +178,13 @@ jobs:
          'semantic-release-vsce',
          {
            packageVsix: false,
-           publishPackagePath: '*.vsix',
+           publishPackagePath: '*/*.vsix',
          },
        ],
        [
          '@semantic-release/github',
          {
-           assets: '*.vsix',
+           assets: '*/*.vsix',
          },
        ],
      ],
@@ -209,55 +209,55 @@ jobs:
       matrix:
         include:
           - os: windows-latest
-            platform: win32
-            arch: x64
+            target: win32-x64
             npm_config_arch: x64
           - os: windows-latest
-            platform: win32
-            arch: ia32
+            target: win32-ia32
             npm_config_arch: ia32
           - os: windows-latest
-            platform: win32
-            arch: arm64
+            target: win32-arm64
             npm_config_arch: arm
           - os: ubuntu-latest
-            platform: linux
-            arch: x64
+            taget: linux-x64
             npm_config_arch: x64
           - os: ubuntu-latest
-            platform: linux
-            arch: arm64
+            target: linux-arm64
             npm_config_arch: arm64
           - os: ubuntu-latest
-            platform: linux
-            arch: armhf
+            target: linux-armhf
             npm_config_arch: arm
           - os: ubuntu-latest
-            platform: alpine
-            arch: x64
+            target: alpine-x64
             npm_config_arch: x64
           - os: macos-latest
-            platform: darwin
-            arch: x64
+            target: darwin-x64
             npm_config_arch: x64
           - os: macos-latest
-            platform: darwin
-            arch: arm64
+            target: darwin-arm64
             npm_config_arch: arm64
+          - os: ubuntu-latest
+            target: universal
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v3
+
       - uses: actions/setup-node@v3
         with:
           node-version: 16
-      - run: npm ci
+
+      - if: matrix.target != 'universal'
+        name: Install dependencies (with binaries)
+        run: npm ci
         env:
           npm_config_arch: ${{ matrix.npm_config_arch }}
-      - shell: pwsh
-        run: echo "target=${{ matrix.platform }}-${{ matrix.arch }}" >> $env:GITHUB_ENV
-      - run: npx semantic-release --extends package.release.config.js
+
+      - if: matrix.target == 'universal'
+        name: Install dependencies (without binaries)
+        run: npm ci
+
+      - run: npx semantic-release --extends ./package.release.config.js
         env:
-          VSCE_TARGET: ${{ env.target }}
+          VSCE_TARGET: ${{ matrix.target }}
           # All tokens are required since semantic-release needs to validate them
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VSCE_PAT: ${{ secrets.VSCE_PAT }}
@@ -266,7 +266,7 @@ jobs:
 
       - uses: actions/upload-artifact@v3
         with:
-          name: ${{ env.target }}
+          name: ${{ matrix.target }}
           path: '*.vsix'
 
   release:
@@ -274,15 +274,21 @@ jobs:
     needs: build
     steps:
       - uses: actions/checkout@v3
+
       - uses: actions/setup-node@v3
         with:
           node-version: 16
+
       - run: npm ci
+
       - uses: actions/download-artifact@v3
-      - run: npx semantic-release --extends publish.release.config.js
+
+      - run: npx semantic-release --extends ./publish.release.config.js
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VSCE_PAT: ${{ secrets.VSCE_PAT }}
           # In case you want to publish to OpenVSX
           OVSX_PAT: ${{ secrets.OVSX_PAT }}
 ```
+
+A reference implementation can also be found in the [VS Code ShellCheck extension](https://github.com/vscode-shellcheck/vscode-shellcheck/pull/805).

package/lib/prepare.js

@@ -40,7 +40,7 @@ module.exports = async (version, packageVsix, logger, cwd) => {
       '--out',
       packagePath,
     ];
-    if (process.env.VSCE_TARGET) {
+    if (isTargetEnabled()) {
       options.push('--target', process.env.VSCE_TARGET);
     }
 

package/lib/utils.js

@@ -3,7 +3,9 @@ const isOvsxEnabled = () => {
 };
 
 const isTargetEnabled = () => {
-  return 'VSCE_TARGET' in process.env;
+  return (
+    'VSCE_TARGET' in process.env && process.env.VSCE_TARGET !== 'universal'
+  );
 };
 
 module.exports = {

package/lib/verify-auth.js

@@ -17,7 +17,7 @@ module.exports = async (logger, cwd) => {
     await execa('vsce', ['verify-pat'], { preferLocal: true, cwd });
   } catch (e) {
     throw new SemanticReleaseError(
-      `Invalid vsce token. Additional information:\n\n${e}`,
+      `Invalid vsce personal access token. Additional information:\n\n${e}`,
       'EINVALIDVSCETOKEN'
     );
   }

package/lib/verify-ovsx-auth.js

@@ -1,9 +1,10 @@
 // @ts-check
 
 const SemanticReleaseError = require('@semantic-release/error');
+const execa = require('execa');
 const { isOvsxEnabled } = require('./utils');
 
-module.exports = async (logger) => {
+module.exports = async (logger, cwd) => {
   logger.log('Verifying authentication for ovsx');
 
   if (!isOvsxEnabled()) {
@@ -20,10 +21,12 @@ module.exports = async (logger) => {
     );
   }
 
-  // TODO: waiting for https://github.com/eclipse/openvsx/issues/313
-  // try {
-  //   await execa('ovsx', ['verify-pat'], { preferLocal: true, cwd });
-  // } catch (e) {
-  //   throw new SemanticReleaseError(`Invalid ovsx personal access token. Additional information:\n\n${e}`, 'EINVALIDOVSXPAT');
-  // }
+  try {
+    await execa('ovsx', ['verify-pat'], { preferLocal: true, cwd });
+  } catch (e) {
+    throw new SemanticReleaseError(
+      `Invalid ovsx personal access token. Additional information:\n\n${e}`,
+      'EINVALIDOVSXPAT'
+    );
+  }
 };

package/lib/verify-target.js

@@ -15,15 +15,17 @@ module.exports = async () => {
     );
   }
 
-  const targets = require('vsce/out/package').Targets;
+  if (process.env.VSCE_TARGET !== 'universal') {
+    const targets = require('@vscode/vsce/out/package').Targets;
 
-  // Throw if the target is not supported
-  if (!targets.has(process.env.VSCE_TARGET)) {
-    throw new SemanticReleaseError(
-      `Unsupported vsce target: ${
-        process.env.VSCE_TARGET
-      }. Available targets: ${Object.values(targets).join(', ')}`,
-      'EUNSUPPORTEDVSCETARGET'
-    );
+    // Throw if the target is not supported
+    if (!targets.has(process.env.VSCE_TARGET)) {
+      throw new SemanticReleaseError(
+        `Unsupported vsce target: ${
+          process.env.VSCE_TARGET
+        }. Available targets: ${Object.values(targets).join(', ')}`,
+        'EUNSUPPORTEDVSCETARGET'
+      );
+    }
   }
 };

package/lib/verify.js

@@ -11,6 +11,6 @@ module.exports = async (pluginConfig, { logger, cwd }) => {
 
   if (pluginConfig?.publish !== false) {
     await verifyAuth(logger, cwd);
-    await verifyOvsxAuth(logger);
+    await verifyOvsxAuth(logger, cwd);
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semantic-release-vsce",
-  "version": "5.3.0",
+  "version": "5.5.0",
   "description": "semantic-release plugin to package and publish VS Code extensions",
   "license": "MIT",
   "engines": {
@@ -48,11 +48,11 @@
   },
   "dependencies": {
     "@semantic-release/error": "^3.0.0",
+    "@vscode/vsce": "^2.15.0",
     "execa": "^5.0.0",
-    "fs-extra": "^10.0.0",
+    "fs-extra": "^11.1.0",
     "glob": "^8.0.3",
-    "ovsx": "^0.5.0",
-    "vsce": "^2.6.3"
+    "ovsx": "^0.6.0"
   },
   "peerDependencies": {
     "semantic-release": ">=18"
@@ -69,10 +69,10 @@
     "husky": "^8.0.2",
     "lint-staged": "^13.0.3",
     "nyc": "^15.1.0",
-    "prettier": "2.7.1",
+    "prettier": "2.8.0",
     "proxyquire": "^2.1.3",
     "semantic-release": "^19.0.2",
-    "sinon": "^14.0.0"
+    "sinon": "^15.0.0"
   },
   "lint-staged": {
     "**/*": "prettier --write --ignore-unknown"

package/test/prepare.test.js

@@ -157,3 +157,33 @@ test('packageVsix when target is set', async (t) => {
     { stdio: 'inherit', preferLocal: true, cwd },
   ]);
 });
+
+test('packageVsix when target is set to universal', async (t) => {
+  const { execaStub } = t.context.stubs;
+  const name = 'test';
+
+  const prepare = proxyquire('../lib/prepare', {
+    execa: execaStub,
+    'fs-extra': {
+      readJson: sinon.stub().returns({
+        name,
+      }),
+    },
+  });
+
+  const version = '1.0.0';
+  const packagePath = `${name}-${version}.vsix`;
+
+  sinon.stub(process, 'env').value({
+    VSCE_TARGET: 'universal',
+  });
+
+  const result = await prepare(version, true, logger, cwd);
+
+  t.deepEqual(result, packagePath);
+  t.deepEqual(execaStub.getCall(0).args, [
+    'vsce',
+    ['package', version, '--no-git-tag-version', '--out', packagePath],
+    { stdio: 'inherit', preferLocal: true, cwd },
+  ]);
+});

package/test/verify-ovsx-auth.test.js

@@ -1,7 +1,10 @@
 const test = require('ava');
 const sinon = require('sinon');
+const proxyquire = require('proxyquire');
 const SemanticReleaseError = require('@semantic-release/error');
 
+const cwd = process.cwd();
+
 test('OVSX_PAT is not set', async (t) => {
   const logger = {
     log: sinon.fake(),
@@ -22,7 +25,12 @@ test('OVSX_PAT is set', async (t) => {
     OVSX_PAT: 'abc123',
   });
 
-  const verifyOvsxAuth = require('../lib/verify-ovsx-auth');
+  const verifyOvsxAuth = proxyquire('../lib/verify-ovsx-auth', {
+    execa: sinon
+      .stub()
+      .withArgs('ovsx', ['verify-pat'], { preferLocal: true, cwd })
+      .resolves(),
+  });
 
   await t.notThrowsAsync(() => verifyOvsxAuth(logger));
   t.true(logger.log.calledOnce);
@@ -44,3 +52,20 @@ test('OVSX_PAT is invalid', async (t) => {
     code: 'EINVALIDOVSXPAT',
   });
 });
+
+test('OVSX_PAT is invalid but not empty', async (t) => {
+  const logger = {
+    log: sinon.fake(),
+  };
+
+  sinon.stub(process, 'env').value({
+    OVSX_PAT: 'abc123',
+  });
+
+  const verifyOvsxAuth = require('../lib/verify-ovsx-auth');
+
+  await t.throwsAsync(() => verifyOvsxAuth(logger), {
+    instanceOf: SemanticReleaseError,
+    code: 'EINVALIDOVSXPAT',
+  });
+});

package/test/verify-target.test.js

@@ -53,3 +53,13 @@ test('VSCE_TARGET is unsupported', async (t) => {
     code: 'EUNSUPPORTEDVSCETARGET',
   });
 });
+
+test('VSCE_TARGET is universal', async (t) => {
+  sinon.stub(process, 'env').value({
+    VSCE_TARGET: 'universal',
+  });
+
+  const verifyTarget = require('../lib/verify-target');
+
+  await t.notThrowsAsync(() => verifyTarget());
+});