Enforce vscode marketplace compatible versioning (#1189)

.config/dictionary.txt

@@ -197,6 +197,7 @@ stdout
 stopendy
 suboption
 suboptions
+subshells
 sysninja
 taskfile
 testenv
@@ -224,8 +225,8 @@ uuidv
 uuidv4
 varInfiles
 venvs
-vscodeignore
 vnet
+vscodeignore
 vscoss
 vsix
 vyos

.github/workflows/ci.yaml

@@ -91,6 +91,9 @@ jobs:
     steps:
 
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # we need tags for dynamic versioning
+          show-progress: false
 
       # https://github.com/marketplace/actions/setup-wsl
       - name: Activate WSL
@@ -263,7 +266,7 @@ jobs:
         if: ${{ matrix.name == 'test' }}
         uses: actions/upload-artifact@v4
         with:
-          name: ansible-extension-build-${{ github.event.number || github.ref_name }}.vsix
+          name: ansible-extension-build-${{ github.event.number || github.ref_name }}.zip
           path: ansible-*.vsix
           if-no-files-found: error
           retention-days: 90

Taskfile.yml

@@ -24,17 +24,13 @@ vars:
     sh: bash -c 'if [[ "$OSTYPE" == "linux-gnu"* ]] && command -v xvfb-run >/dev/null; then echo "$(command -v xvfb-run) --auto-servernum -e out/log/xvfb.log"; fi'
 tasks:
   default:
-    vars:
-      VERSION:
-        sh: node -p "require('./package.json').version"
     desc: Run most commands
     deps:
       - install
       - lint
       - package
     cmds:
       - echo {{.TASK}}
-      - echo Done {{.VERSION}}!
   setup:
     desc: Install dependencies
     deps:
@@ -161,9 +157,6 @@ tasks:
       - npm run unit-tests
     interactive: true
   package:
-    vars:
-      VERSION:
-        sh: node -p "require('./package.json').version"
     desc: Package extension
     deps:
       - build
@@ -179,15 +172,7 @@ tasks:
     generates:
       - "*.vsix"
     cmds:
-      - rm -f *.vsix
-      - yarn run webpack
-      # --pre-release not supported until we do VS Code >=1.63
-      # --no-dependencies and --no-yarn needed due to https://github.com/microsoft/vscode-vsce/issues/439
-      - yarn run vsce package --pre-release --no-dependencies --no-git-tag-version --no-update-package-json {{.VERSION}}
-      # Using zipinfo instead of `npx vsce ls` due to https://github.com/microsoft/vscode-vsce/issues/517
-      - zipinfo -1 *.vsix
-      - tools/dirty.sh
-      - ls -la *.vsix
+      - ./tools/package.sh
     silent: true
   pr:
     desc: Opens a pull request using gh

package.json

@@ -770,7 +770,7 @@
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "@typescript-eslint/parser": "^6.21.0",
     "@vscode/test-electron": "^2.3.9",
-    "@vscode/vsce": "^2.23.0",
+    "@vscode/vsce": "^2.24.0",
     "axios": "^1.6.7",
     "chai": "^4.4.1",
     "copyfiles": "^2.4.1",
@@ -832,7 +832,7 @@
   "scripts": {
     "compile": "tsc -b && copyfiles -u 4 'node_modules/@ansible/ansible-language-server/out/server/**/*' out",
     "compile-withserver": "tsc -b && tsc -p ../ansible-language-server --outDir out/server && ln -f -s ${PWD}/../ansible-language-server/node_modules out/server/node_modules",
-    "package": "yarn run webpack && npx vsce package",
+    "package": "./tools/package.sh",
     "preinstall": "",
     "pretest": "yarn run compile",
     "unit-tests": "nyc mocha --recursive test/units",

tools/get-marketplace-version.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+# Retries a vscode marketplace compatible version number to be used by
+# vsce package && vsce publish. These require numeric only, X.Y.Z with ranges
+# between 0-2147483647. Package allows other version numbers but publish does
+# not.
+#
+# We used the build number in the past, but that would not allow use retrigger
+# a build and might cause problems when switching from a CI to another. Thus,
+# we opted for number of seconds passed between last tag and last commit. This
+# should generate 0 for tagged commits and other numbers for pull requests.
+set -Ee
+LAST_TAG=$(git describe --tags --abbrev=0)
+LAST_TAG_TIMESTAMP=$(git -P log -1 --format=%ct "${LAST_TAG}")
+LAST_COMMIT_TIMESTAMP=$(git -P show --no-patch --format=%ct HEAD)
+VERSION_SUFFIX="$((LAST_COMMIT_TIMESTAMP-LAST_TAG_TIMESTAMP))"
+# We remove the last number from the node reported version.
+VERSION_PREFIX=$(node -p "require('./package.json').version")
+echo -n "${VERSION_PREFIX%.*}.${VERSION_SUFFIX}"

tools/package.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+# (cspell: disable-next-line)
+set -Eeuo pipefail
+# ^ capital E needed as we want to fail for subshells too.
+rm -f ./*.vsix
+yarn run webpack
+VERSION="$(./tools/get-marketplace-version.sh)"
+vsce_package_args=(--no-dependencies --no-git-tag-version --no-update-package-json)
+if [[ "$VERSION" == *.0 ]]; then
+    vsce_package_args+=("--pre-release")
+fi
+# --no-dependencies and --no-yarn needed due to https://github.com/microsoft/vscode-vsce/issues/439
+yarn run vsce package "${vsce_package_args[@]}" "${VERSION}"
+# Using zipinfo instead of `npx vsce ls` due to https://github.com/microsoft/vscode-vsce/issues/517
+zipinfo -1 ./*.vsix > out/log/package.log
+tools/dirty.sh
+echo "Generated ansible-${VERSION}"

webpack.config.ts

@@ -67,7 +67,7 @@ const config = {
   stats: {
     errorDetails: true,
     moduleTrace: true,
-    preset: "minimal",
+    preset: "errors-warnings",
   },
   target: "node", // vscode extensions run in a Node.js-context
 };

yarn.lock

@@ -1460,7 +1460,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@vscode/vsce@npm:^2.19.0, @vscode/vsce@npm:^2.23.0, @vscode/vsce@npm:^2.24.0":
+"@vscode/vsce@npm:^2.19.0, @vscode/vsce@npm:^2.24.0":
   version: 2.24.0
   resolution: "@vscode/vsce@npm:2.24.0"
   dependencies:
@@ -1963,7 +1963,7 @@ __metadata:
     "@typescript-eslint/eslint-plugin": "npm:^6.21.0"
     "@typescript-eslint/parser": "npm:^6.21.0"
     "@vscode/test-electron": "npm:^2.3.9"
-    "@vscode/vsce": "npm:^2.23.0"
+    "@vscode/vsce": "npm:^2.24.0"
     "@vscode/webview-ui-toolkit": "npm:^1.4.0"
     axios: "npm:^1.6.7"
     chai: "npm:^4.4.1"