feat(publish-npm): add dry-run option

Author: PierreJeanjacquot

.github/workflows/publish-npm.yml

@@ -79,6 +79,10 @@ on:
         description: 'Version to publish (leave empty to use package.json version)'
         default: ''
         type: string
+      dry-run:
+        description: 'Run in dry-run mode (the package will not be published)'
+        default: false
+        type: boolean
     secrets:
       npm-token:
         description: 'NPM auth token'
@@ -144,13 +148,19 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{ secrets.npm-token }}
         run: |
-          TAG_OPT=""
+          TAG_OPT=""          
           if [ -n "${{ inputs.tag }}" ]; then
             TAG_OPT="--tag ${{ inputs.tag }}"
           fi
 
+          DRY_RUN_OPT=""
+          if [ "${{ inputs.dry-run }}" = "true" ]; then
+            DRY_RUN_OPT="--dry-run"
+          fi
+
+          PROVENANCE_OPT=""
           if [ "${{ inputs.provenance }}" = "true" ]; then
-            npm publish --access ${{ inputs.access }} $TAG_OPT --provenance
+            PROVENANCE_OPT="--provenance"
           else
-            npm publish --access ${{ inputs.access }} $TAG_OPT
-          fi
+
+          npm publish --access ${{ inputs.access }} $TAG_OPT $DRY_RUN_OPT $PROVENANCE_OPT

publish-npm/README.md

@@ -20,7 +20,7 @@ for the package scope, Node.js version, registry URL, and other options. The wor
 ## Workflow Inputs 🛠️
 
 | **Input**                | **Description**                                               | **Required** | **Default**                         |
-|--------------------------|---------------------------------------------------------------|--------------|-------------------------------------|
+| ------------------------ | ------------------------------------------------------------- | ------------ | ----------------------------------- |
 | **scope**                | NPM package scope (e.g., `@iexec`).                           | No           | `@iexec`                            |
 | **node-version**         | Node.js version to use.                                       | No           | `20`                                |
 | **registry**             | NPM registry URL.                                             | No           | `https://registry.npmjs.org`        |
@@ -40,11 +40,12 @@ for the package scope, Node.js version, registry URL, and other options. The wor
 | **artifact-name**        | Name of an artifact to download before the build.             | No           | `''` (empty string)                 |
 | **artifact-path**        | Destination path for the downloaded artifact.                 | No           | `''` (empty string)                 |
 | **version**              | Version to publish (leave empty to use package.json version). | No           | `''` (empty string)                 |
+| **dry-run**              | Run in dry-run mode (the package will not be published).      | No           | `false`                             |
 
 ### Secrets 🔐
 
 | **Secret**    | **Description** | **Required** |
-|---------------|-----------------|--------------|
+| ------------- | --------------- | ------------ |
 | **npm-token** | NPM auth token. | Yes          |
 
 ## Job and Steps ⚙️
@@ -54,9 +55,9 @@ for the package scope, Node.js version, registry URL, and other options. The wor
 - **Runs On**: `ubuntu-latest`.
 - **Environment**: Uses the environment specified in `inputs.environment`.
 - **Permissions**:
-    - `contents: read` – to access repository contents. 🔍
-    - `packages: write` – to allow package publication. ✨
-    - `id-token: write` – for authentication purposes. 🔑
+  - `contents: read` – to access repository contents. 🔍
+  - `packages: write` – to allow package publication. ✨
+  - `id-token: write` – for authentication purposes. 🔑
 
 ## How to Use This Reusable Workflow 🔄
 
@@ -76,14 +77,14 @@ for the package scope, Node.js version, registry URL, and other options. The wor
      publish:
        uses: iExecBlockchainComputing/github-actions-workflows/.github/workflows/publish-npm.yml@main
        with:
-         node-version: '22'
-         build-command: 'npm run build:prod'
+         node-version: "22"
+         build-command: "npm run build:prod"
          run-tests: true
-         test-command: 'npm run test:ci'
-         lint-command: 'npm run lint'
-         type-check-command: 'npm run check-types'
-         format-check-command: 'npm run check-format'
-         tag-prefix: 'v'
+         test-command: "npm run test:ci"
+         lint-command: "npm run lint"
+         type-check-command: "npm run check-types"
+         format-check-command: "npm run check-format"
+         tag-prefix: "v"
          # Optional: Download an artifact before building
          # artifact-name: 'my-build-artifact'
          # artifact-path: './dist'