[ci] harmonize release doc, add helper scripts

Make this repo more similar to our other cdt-cloud repos:
- install lerna as a devDependency, use repo root as the single
  lerna workspace
- provide package.json helper scripts that use "lerna version", to
  help step the version and create the release commit
- document release process in root README-dev
- prevent triggering release-related jobs on forks

Signed-off-by: Marc Dumais <[email protected]>

Author: marcdumais-work

.github/workflows/ci-cd.yml

@@ -70,7 +70,7 @@ jobs:
         os: [ubuntu-latest]
         node-version: [18]
     # Only execute when the trigger was a tag (new release)
-    if: github.event_name == 'release' && startsWith(github.ref, 'refs/tags/v')
+    if: github.event_name == 'release' && startsWith(github.ref, 'refs/tags/v') && github.repository == 'eclipse-cdt-cloud/vscode-trace-server'
 
     steps:
       - uses: actions/checkout@v4
@@ -103,7 +103,7 @@ jobs:
         os: [ubuntu-latest]
         node-version: [18]
     # Only execute when the trigger was a tag (new release)
-    if: github.event_name == 'release' && startsWith(github.ref, 'refs/tags/v')
+    if: github.event_name == 'release' && startsWith(github.ref, 'refs/tags/v') && github.repository == 'eclipse-cdt-cloud/vscode-trace-server'
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/release.yml

@@ -1,37 +1,38 @@
 name: Create or prepare GitHub release
 
 on:
-    push:
-        branches:    
-          - main
-        paths:
-          - 'RELEASE'
-    pull_request:
-        types: [opened, synchronize]
-        branches:
-          - main
-        paths:
-          - 'RELEASE'
+  push:
+    branches:    
+      - main
+    paths:
+      - 'RELEASE'
+  pull_request:
+    types: [opened, synchronize]
+    branches:
+      - main
+    paths:
+      - 'RELEASE'
 
 jobs:
-    gh-release:
-        name: GitHub release
-        runs-on: ubuntu-latest
-        
-        steps:
-            - uses: actions/checkout@v4
-              with:
-                fetch-depth: 0
-            - uses: pipe-cd/[email protected]
-              with:
-                release_file: 'RELEASE'
-                # Actions that run using the auto-generated GitHub token are
-                # not allowed to trigger a new workflow run. In this case we want
-                # the tag created by actions-gh-release to trigger the main workflow
-                # and result in publishing the extension to open-vsx.
-                # The following scopes are required when creating the committer token:
-                #  - repo:status, repo_deployment, public_repo, read:org
-                # See here for more details:
-                # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow
-                token: ${{ secrets.GH_COMMITTER_TOKEN }}
-              
+  gh-release:
+    name: GitHub release
+    if: github.repository == 'eclipse-cdt-cloud/vscode-trace-server'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: pipe-cd/[email protected]
+        with:
+          release_file: 'RELEASE'
+          # Actions that run using the auto-generated GitHub token are
+          # not allowed to trigger a new workflow run. In this case we want
+          # the tag created by actions-gh-release to trigger the main workflow
+          # and result in publishing the extension to open-vsx.
+          # The following scopes are required when creating the committer token:
+          #  - repo:status, repo_deployment, public_repo, read:org
+          # See here for more details:
+          # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#using-the-github_token-in-a-workflow
+          token: ${{ secrets.GH_COMMITTER_TOKEN }}
+          

README-dev.md

@@ -98,6 +98,37 @@ yarn format:write
 
 ```
 
+## Release/publish
+
+We use GitHub CI to create a GitHub release and the corresponding git tag, and also to publish this repo's VSCode extension to the `open-vsx.org` and the `Visual Studio Marketplace` registries.
+
+### Triggering a new release
+
+Whenever a new release is desired, it can be triggered through a PR, as per the following:
+
+Create a new branch for your PR, based on the repo's latest state. e.g.
+
+```bash
+git branch new-release && git checkout new-release
+```
+
+Then decide if the release shall be a `Major`, `Minor` or `Patch` release and use the corresponding command below to step the package's versions, according to the release type. A new release commit will be created:
+
+``` bash
+yarn version:major
+# or
+yarn version:minor
+# or
+yarn version:patch
+```
+
+Modify the _version tag_ in file `./RELEASE`, to match the new release. Amend the release commit to include this change:
+
+```bash
+git add RELEASE && git commit --amend
+```
+
+Finally, push the branch to the main repository (not a fork!) and use it to create a PR. When the PR is merged, a GitHub release should be created with auto-generated release notes, as well as a git tag. Then the `publish-*` CI jobs should trigger, and if everything goes well, publish the new version of the extension to both registries.
 
 [backlog]: https://github.com/eclipse-cdt-cloud/vscode-trace-extension/issues/15
 [blueprint]: https://theia-ide.org/docs/blueprint_download

lerna.json

@@ -0,0 +1,12 @@
+{
+    "version": "0.2.1",
+    "npmClient": "yarn",
+    "command": {
+        "run": {
+            "stream": true
+        }
+    },
+    "packages": [
+        "."
+    ]
+}

package.json

@@ -75,6 +75,9 @@
         "format:write": "prettier --write ./src",
         "format:check": "prettier --check ./src",
         "test": "node ./out/test/runTest.js",
+        "version:major": "lerna version major --exact --no-push --git-tag-command /usr/bin/true --yes -m \"Release %s (Major)\"",
+        "version:minor": "lerna version minor --exact --no-push --git-tag-command /usr/bin/true --yes -m \"Release %s (Minor)\"",
+        "version:patch": "lerna version patch --exact --no-push --git-tag-command /usr/bin/true --yes -m \"Release %s (Patch)\"",
         "license:check": "npx dash-licenses-wrapper  --configFile=./configs/license-check-config.json",
         "license:check:review": "npx dash-licenses-wrapper  --configFile=./configs/license-check-config.json --review"
     },
@@ -94,6 +97,7 @@
         "@vscode/vsce": "^2.20.1",
         "eslint": "8.43.0",
         "glob": "^8.1.0",
+        "lerna": "^7.0.0",
         "mocha": "^10.2.0",
         "prettier": "2.8.8",
         "ts-loader": "^9.4.2",