ci: add dry run capability to release workflow

mato533 · mato533 · commit bd624bb17948 · 2025-05-28T15:44:16.000+09:00
[skip ci]
diff --git a/.github/scripts/genPreReleaseVersion.js b/.github/scripts/genPreReleaseVersion.js
@@ -1 +1 @@
-console.log(Math.floor(Date.now() / 1000))
+console.log(Math.floor(Date.now() / 10000))
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,5 +1,7 @@
 name: Manual Publish
 
+run-name: Manual Publish${{ github.event.inputs.dryRun == 'yes' && ' (DRY RUN)' || '' }}
+
 on:
     workflow_dispatch:
         inputs:
@@ -12,9 +14,10 @@ on:
                     - patch
                     - minor
                     - major
-                    - premajor
-                    - preminor
                     - prepatch
+                    - preminor
+                    - premajor
+                    - prerelease
             publishMarketplace:
                 description: 'Publish on Visual Studio Marketplace?'
                 required: true
@@ -23,6 +26,14 @@ on:
                 options:
                     - 'yes'
                     - 'no'
+            dryRun:
+                description: 'Dry run? If yes, this workflow will NOT push to remote and NOT publish the extension.'
+                required: true
+                type: choice
+                default: 'no'
+                options:
+                    - 'yes'
+                    - 'no'
 
 jobs:
     release:
@@ -59,7 +70,6 @@ jobs:
               run: |
                   pnpm lerna version ${{github.event.inputs.releaseType}} --no-push --exact --preid next --yes -m "chore(release): %s"
               env:
-                  NODE_ENV: production
                   GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
                   VSCODE_WDIO_PRE_RELEASE_PATCH_NUMBER: ${{ steps.gen-pre-release-ver.outputs.version }}
 
@@ -68,8 +78,9 @@ jobs:
               run: |
                   pnpm run publish:next
               env:
-                  GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
                   VSCE_PAT: ${{ secrets.VSCE_PAT }}
+                  GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
+                  VSCODE_WDIO_DRY_RUN: ${{ github.event.inputs.dryRun }}
                   VSCODE_WDIO_PRE_RELEASE_PATCH_NUMBER: ${{ steps.gen-pre-release-ver.outputs.version }}
 
             - name: 🚀 Build and publish
@@ -79,10 +90,12 @@ jobs:
               env:
                   VSCE_PAT: ${{ secrets.VSCE_PAT }}
                   GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
+                  VSCODE_WDIO_DRY_RUN: ${{ github.event.inputs.dryRun }}
 
             - name: 📝 Create the Github Release
               run: |
                   pnpm --filter @vscode-wdio/release run release-note
               env:
                   GITHUB_AUTH: ${{ secrets.GITHUB_TOKEN }}
+                  VSCODE_WDIO_DRY_RUN: ${{ github.event.inputs.dryRun }}
                   VSCODE_WDIO_RELEASE_NOTE: ${{ steps.bump.outputs.changelog }}
diff --git a/infra/release/src/createRelease.ts b/infra/release/src/createRelease.ts
@@ -1,27 +1,45 @@
+import path from 'node:path'
+import url from 'node:url'
+
 import { Octokit } from '@octokit/rest'
+import * as dotenv from 'dotenv'
 
 import pkg from '../../../lerna.json' with { type: 'json' }
+
 /**
  * make GitHub release for machine readable changelog
  */
+const __dirname = path.dirname(url.fileURLToPath(import.meta.url))
+const root = path.resolve(__dirname, '..', '..', '..')
+dotenv.config({ path: path.join(root, '.env') })
 
 const api = new Octokit({ auth: process.env.GITHUB_AUTH })
-
-const isGithubActions = Boolean(process.env.GITHUB_ACTIONS)
-if (!isGithubActions) {
-    console.log('\nSkip creating the Github Release because this is not running on the Github Actions.')
-    process.exit(0)
-}
 const newChangelog = process.env.VSCODE_WDIO_RELEASE_NOTE
 if (!newChangelog) {
     console.error('The release note is not set. please set as environment variable `VSCODE_WDIO_RELEASE_NOTE`')
     process.exit(1)
 }
 
+const repo = process.env.GITHUB_REPOSITORY || ''
+const [owner, repoName] = repo.split('/')
+if (owner !=='webdriverio' || repoName !== 'vscode-webdriverio'){
+    console.error(`This repository is not correct repository. (Current: ${repo})`)
+    process.exit(1)
+}
+
+if (process.env.VSCODE_WDIO_DRY_RUN === 'yes') {
+    console.log('*---- DRY RUN ----*')
+    console.log(`tag_name: v${pkg.version}`)
+    console.log(`name:     v${pkg.version}`)
+    console.log(newChangelog)
+    process.exit(0)
+}
+console.log(`Creating Github Release: v${pkg.version}`)
 api.repos.createRelease({
     owner: 'webdriverio',
     repo: 'vscode-webdriverio',
     tag_name: `v${pkg.version}`,
     name: `v${pkg.version}`,
     body: newChangelog,
 })
+console.log(`Created Github Release: v${pkg.version}`)
diff --git a/infra/release/src/push.ts b/infra/release/src/push.ts
@@ -8,12 +8,13 @@ import shell from 'shelljs'
 
 import pkg from '../../../lerna.json' with { type: 'json' }
 
-const isGithubActions = Boolean(process.env.GITHUB_ACTIONS)
-
-console.log('\nPushing release tag...')
-if (!isGithubActions) {
-    console.log('\nSkip pushing because this is not running on the Github Actions.')
+if (process.env.VSCODE_WDIO_DRY_RUN === 'yes') {
+    console.log('dryRun is `yes`. Skip the push.')
     process.exit(0)
 }
+
+console.log('Pushing the commit and tag.')
 shell.exec('git push origin --no-verify')
 shell.exec(`git push origin refs/tags/v${pkg.version} -f --no-verify`)
+console.log('Successfully pushed.')
+
diff --git a/infra/release/src/utils.ts b/infra/release/src/utils.ts
@@ -13,7 +13,8 @@ export const createPreReleaseVer = (version: string) => {
     if (!patchNumber) {
         throw new Error('VSCODE_WDIO_PRE_RELEASE_PATCH_NUMBER is not set. Please check the environment variables.')
     }
-    const newVersion = version.split('.').slice(0, 2)
-    newVersion.push(patchNumber)
+    const [major, minor, patch] = version.split('.')
+    const newVersion = [major, minor]
+    newVersion.push(`${patch.split('-')[0]}${patchNumber}`.slice(0, 9))
     return `${newVersion.join('.')}`
 }
diff --git a/package.json b/package.json
@@ -31,6 +31,7 @@
         "coverage": "vitest --run --coverage",
         "graph": "pnpm run build --graph assets/build.png",
         "version": "pnpm --filter @vscode-wdio/release run changelog && git add CHANGELOG.md",
+        "postversion": "git show",
         "postinstall": "run-s postinstall:*",
         "postinstall:husky": "husky"
     },
diff --git a/packages/vscode-webdriverio/package.json b/packages/vscode-webdriverio/package.json
@@ -28,7 +28,7 @@
         "prepackage:copy": "pnpm --filter @vscode-wdio/release run copy",
         "prepackage:update-version": "pnpm --filter @vscode-wdio/release run update-version",
         "package": "vsce package",
-        "publish": "vsce publish",
+        "publish": "tsx ./scripts/publish.ts",
         "postpublish": "pnpm --filter @vscode-wdio/release run push",
         "package:next": "pnpm run package --pre-release",
         "publish:next": "pnpm run publish --pre-release",
diff --git a/packages/vscode-webdriverio/scripts/publish.ts b/packages/vscode-webdriverio/scripts/publish.ts
@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+import shell from 'shelljs'
+
+if (process.env.VSCODE_WDIO_DRY_RUN === 'yes') {
+    console.log('dryRun is `yes`. Skip the publish.')
+    process.exit(0)
+}
+
+const args = process.argv.slice(2)
+const command = `vsce publish ${args.join(' ')}`
+
+console.log(`Running: ${command}`)
+shell.exec(command)
+console.log('Successfully published.')
diff --git a/turbo.json b/turbo.json
@@ -1,5 +1,6 @@
 {
     "$schema": "https://turbo.build/schema.json",
+    "globalEnv": ["GITHUB_*", "VSCODE_WDIO_*", "VSCE_PAT"],
     "tasks": {
         "clean": {},
         "build": {
@@ -16,20 +17,16 @@
             "cache": false
         },
         "vscode-webdriverio#package": {
-            "dependsOn": ["build:production"],
-            "env": ["GITHUB_ACTIONS", "GITHUB_AUTH", "VSCE_PAT"]
+            "dependsOn": ["build:production"]
         },
         "vscode-webdriverio#publish": {
-            "dependsOn": ["package"],
-            "env": ["GITHUB_ACTIONS", "GITHUB_AUTH", "VSCE_PAT"]
+            "dependsOn": ["package"]
         },
         "vscode-webdriverio#package:next": {
-            "dependsOn": ["build:production"],
-            "env": ["GITHUB_ACTIONS", "GITHUB_AUTH", "VSCE_PAT", "VSCODE_WDIO_PRE_RELEASE_PATCH_NUMBER"]
+            "dependsOn": ["build:production"]
         },
         "vscode-webdriverio#publish:next": {
-            "dependsOn": ["package:next"],
-            "env": ["GITHUB_ACTIONS", "GITHUB_AUTH", "VSCE_PAT"]
+            "dependsOn": ["package:next"]
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-console.log(Math.floor(Date.now() / 1000))`
	`1`	`+console.log(Math.floor(Date.now() / 10000))`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,8 @@ export const createPreReleaseVer = (version: string) => {`
`13`	`13`	`if (!patchNumber) {`
`14`	`14`	`throw new Error('VSCODE_WDIO_PRE_RELEASE_PATCH_NUMBER is not set. Please check the environment variables.')`
`15`	`15`	`}`
`16`		`- const newVersion = version.split('.').slice(0, 2)`
`17`		`- newVersion.push(patchNumber)`
	`16`	`+ const [major, minor, patch] = version.split('.')`
	`17`	`+ const newVersion = [major, minor]`
	`18`	+ newVersion.push(`${patch.split('-')[0]}${patchNumber}`.slice(0, 9))
`18`	`19`	return `${newVersion.join('.')}`
`19`	`20`	`}`