Update release workflow to allow publishing pre-releases to the VSCode Marketplace and OpenVSX (#777)

Both VSCode Marketplace and OpenVSX have a concept of "pre-releases",
versions of an VSCode extension which can be published to these
marketplaces but only installed for users who opt into receiving pre-release
versions.

Using this mechanism provides a more robust way of validating new
changes to vscode-clangd before pushing them out to all users in a
stable release.

The workflow considers anything with an odd minor version number
(e.g. 0.1.34) to be a pre-release, while anything with an even minor
version number (e.g. 0.2.0) will be a stable release. This allows us to
control the type of release by bumping the version number appropriately.

Fixes #765

Author: JVApen

.github/workflows/auto-release.yml

@@ -17,28 +17,51 @@ jobs:
       id: check
       with:
         diff-search: true # seach the diff content with version
+    - if: steps.check.outputs.changed == 'true'
+      id: is_preview
+      run: |
+        IFS='.' read -r -a array <<< "${{ steps.check.outputs.version }}"
+        if [ $((array[1]%2)) -eq 0 ];
+        then
+          echo is_preview="false" >> "$GITHUB_OUTPUT"
+        else
+          echo is_preview="true" >> "$GITHUB_OUTPUT"
+        fi
+      shell: bash
     - if: steps.check.outputs.changed == 'true'
       run: npm ci
     - if: steps.check.outputs.changed == 'true'
       run: npm test
     - name: package
-      if: steps.check.outputs.changed == 'true'
+      if: steps.check.outputs.changed == 'true' && steps.is_preview.outputs.is_preview == 'false'
       run: npm run package
+    - name: package
+      if: steps.check.outputs.changed == 'true' && steps.is_preview.outputs.is_preview == 'true'
+      run: npm run package-pre-release
     - name: publish to Github
       uses: ncipollo/release-action@v1
       if: steps.check.outputs.changed == 'true'
       with:
         artifacts: "vscode-clangd-*.vsix"
         tag: ${{ steps.check.outputs.version }}
         commit: ${{ steps.check.outputs.commit }}
+        prerelease: ${{ steps.is_preview.outputs.is_preview }}
         token: ${{ secrets.GITHUB_TOKEN }}
     - name: publish to VSCode Marketplace
-      if: steps.check.outputs.changed == 'true'
+      if: steps.check.outputs.changed == 'true' && steps.is_preview.outputs.is_preview == 'false'
       # The token will expire. Regenerate it at:
       # https://llvm-vs-code-extensions.visualstudio.com/_usersSettings/tokens.
       run: npm run publish -- -p "${{ secrets.VSCODE_MARKETPLACE_TOKEN }}"
+    - name: publish to VSCode Marketplace
+      if: steps.check.outputs.changed == 'true' && steps.is_preview.outputs.is_preview == 'true'
+      run: npm run publish-pre-release -- -p "${{ secrets.VSCODE_MARKETPLACE_TOKEN }}"
     - name: publish to OpenVSX
-      if: steps.check.outputs.changed == 'true'
+      if: steps.check.outputs.changed == 'true' && steps.is_preview.outputs.is_preview == 'false'
       # The token will expire. Regenerate it at:
       # https://open-vsx.org/user-settings/tokens
       run: npm run publish-openvsx -- -p "${{ secrets.OPENVSX_TOKEN }}"
+    - name: publish to OpenVSX
+      if: steps.check.outputs.changed == 'true' && steps.is_preview.outputs.is_preview == 'true'
+      # The token will expire. Regenerate it at:
+      # https://open-vsx.org/user-settings/tokens
+      run: npm run publish-openvsx-pre-release -- -p "${{ secrets.OPENVSX_TOKEN }}"

CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## Version 0.1.34: March 15, 2025
+
+* Create pre-release flows [#748](https://github.com/clangd/vscode-clangd/issues/748) [#753](https://github.com/clangd/vscode-clangd/issues/753) [#765](https://github.com/clangd/vscode-clangd/issues/765)
+* Clean up disposables in early-return path of ClangdContext.create() [#743](https://github.com/clangd/vscode-clangd/issues/743)
+* Publish API package to the default registry [#746](https://github.com/clangd/vscode-clangd/issues/746)
+* Documentation
+  * Mention the clangd config file in the README [#752](https://github.com/clangd/vscode-clangd/issues/752)
+  * Mention the editor.defaultFormatter setting [#768](https://github.com/clangd/vscode-clangd/issues/768)
+* Add an option to allow "clangd.path" to point to a shell script [#683](https://github.com/clangd/vscode-clangd/issues/683)
+* Automatically restart clangd language server after it is installed [#749](https://github.com/clangd/vscode-clangd/issues/749)
+* Handle workspace symbols searches with a '::' prefix [#769](https://github.com/clangd/vscode-clangd/issues/769)
+
 ## Version 0.1.33: November 21, 2024
 
 * Reverted [#730](https://github.com/clangd/vscode-clangd/pull/730) for causing [#734](https://github.com/clangd/vscode-clangd/issues/734)

package-lock.json

@@ -2,7 +2,7 @@
     "name": "vscode-clangd",
     "displayName": "clangd",
     "description": "C/C++ completion, navigation, and insights",
-    "version": "0.1.33",
+    "version": "0.1.34",
     "publisher": "llvm-vs-code-extensions",
     "license": "MIT",
     "homepage": "https://clangd.llvm.org/",
@@ -44,6 +44,9 @@
         "package": "vsce package --baseImagesUrl https://raw.githubusercontent.com/clangd/vscode-clangd/master/",
         "publish": "vsce publish --baseImagesUrl https://raw.githubusercontent.com/clangd/vscode-clangd/master/",
         "publish-openvsx": "ovsx publish --baseImagesUrl https://raw.githubusercontent.com/clangd/vscode-clangd/master/",
+        "package-pre-release": "vsce package --pre-release --baseImagesUrl https://raw.githubusercontent.com/clangd/vscode-clangd/master/",
+        "publish-pre-release": "vsce publish --pre-release --baseImagesUrl https://raw.githubusercontent.com/clangd/vscode-clangd/master/",
+        "publish-openvsx-pre-release": "ovsx publish --pre-release --baseImagesUrl https://raw.githubusercontent.com/clangd/vscode-clangd/master/",
         "git-clang-format": "git-clang-format --extensions=ts"
     },
     "dependencies": {
@@ -404,4 +407,4 @@
             ]
         }
     }
-}
+}