ci(publish-npm): clarify that the package input is the package_dir

Alenar · Alenar · commit a7f79faebc49 · 2025-11-03T15:40:08.000+01:00
- rename input `package` to `package_dir`, this is mostly a semantic
  change since it was already used as such
- extract the package name from the `package.json` file (this have the
  additionnal advantage of retrieving the scope since it's included in
  the name)
- use `working-directory: ${{ inputs.package_dir }}` instead of doing
  manual `cd` where applicable
- fix console prints that were talking about `crates.io` which is
  incorrect since everything is done against `npmjs.com` in this
  workflow
diff --git a/.github/workflows/actions/publish-npm-package/action.yml b/.github/workflows/actions/publish-npm-package/action.yml
@@ -5,8 +5,8 @@ inputs:
   dry_run:
     description: Dry run will not publish to npm, just test it.
     required: true
-  package:
-    description: npm package name.
+  package_dir:
+    description: directory containing the package.json file.
     required: true
   scope:
     description: npm package scope (must not include '@' prefix).
@@ -26,40 +26,46 @@ inputs:
 runs:
   using: "composite"
   steps:
+    - name: Prepare
+      id: prepare
+      shell: bash
+      run: |
+        echo "package_name=$(jq -r ".name" < "${{ inputs.package_dir }}"/package.json)" >> $GITHUB_OUTPUT
+        echo "package_local_version=$(jq -r ".version" < "${{ inputs.package_dir }}"/package.json)" >> $GITHUB_OUTPUT
+
     - name: Check npm latest version
       id: check_version
       shell: bash
       run: |
-        echo "Check crate latest published version for '${{ inputs.package }}' package"
+        echo "Check npmjs.com latest published version for '${{ steps.prepare.outputs.package_name }}' package"
 
         if [ "${{ inputs.tag }}" != "latest" -a "${{ inputs.tag }}" != "next" ]; then
           echo "Tag '${{ inputs.tag }}' is not valid. It should be one of 'latest' or 'next'"
           exit 1
         fi
 
-        LOCAL_VERSION=$(cat ${{ inputs.package }}/package.json | jq -r '.version')
-        NEXT_REMOTE_VERSION=$(npm view @${{ inputs.scope }}/${{ inputs.package }} dist-tags.next 2> /dev/null || true)
-        LATEST_REMOTE_VERSION=$(npm view @${{ inputs.scope }}/${{ inputs.package }} dist-tags.latest 2> /dev/null || true)
+        NEXT_REMOTE_VERSION=$(npm view ${{ steps.prepare.outputs.package_name }} dist-tags.next 2> /dev/null || true)
+        LATEST_REMOTE_VERSION=$(npm view ${{ steps.prepare.outputs.package_name }} dist-tags.latest 2> /dev/null || true)
 
-        echo "Latest crate.io version: '$LATEST_REMOTE_VERSION'"
-        echo "Next crate.io version: '$NEXT_REMOTE_VERSION'"
-        echo "Local version: '$LOCAL_VERSION'"
+        echo "Latest npmjs.com version: '$LATEST_REMOTE_VERSION'"
+        echo "Next npmjs.com version: '$NEXT_REMOTE_VERSION'"
+        echo "Local version: '${{ steps.prepare.outputs.package_local_version }}'"
 
         if [ "${{ inputs.tag }}" == "latest" ]; then
-          if [ "$LOCAL_VERSION" == "$LATEST_REMOTE_VERSION" ]; then
+          if [ "${{ steps.prepare.outputs.package_local_version }}" == "$LATEST_REMOTE_VERSION" ]; then
             echo "Local version and remote version are the same: no need to publish to npm registry"
             DEPLOY_MODE='none'
-          elif [ "$LOCAL_VERSION" == "$NEXT_REMOTE_VERSION" ]; then
+          elif [ "${{ steps.prepare.outputs.package_local_version }}" == "$NEXT_REMOTE_VERSION" ]; then
             DEPLOY_MODE='promote'
           else
             DEPLOY_MODE='publish'
           fi
         else # input.tag == 'next'
-          if [ "$LOCAL_VERSION" == "$LATEST_REMOTE_VERSION" ]; then
+          if [ "${{ steps.prepare.outputs.package_local_version }}" == "$LATEST_REMOTE_VERSION" ]; then
             # A latest already published: no need to tag with next
             echo "Local version and remote version are the same: no need to publish to npm registry"
             DEPLOY_MODE='none'
-          elif [ "$LOCAL_VERSION" == "$NEXT_REMOTE_VERSION" ]; then
+          elif [ "${{ steps.prepare.outputs.package_local_version }}" == "$NEXT_REMOTE_VERSION" ]; then
             echo "Local version and remote version are the same: no need to publish to npm registry"
             DEPLOY_MODE='none'
           else
@@ -70,43 +76,43 @@ runs:
         echo "Deploy mode: '$DEPLOY_MODE'"
         echo "Dry run: '${{ inputs.dry_run }}'"
         echo "deploy_mode=$DEPLOY_MODE" >> $GITHUB_OUTPUT
-        echo "package_version=$LOCAL_VERSION" >> $GITHUB_OUTPUT
 
     - name: Build package
       shell: bash
-      working-directory: ${{ inputs.package }}
+      working-directory: ${{ inputs.package_dir }}
       env:
         WASM_PACK_ARGS: --release --scope ${{ inputs.scope }}
       run: |
-        echo "Build '@${{ inputs.scope }}/${{ inputs.package }}' package"
+        echo "Build '${{ steps.prepare.outputs.package_name }}' package"
         make build
 
     - name: Prepare publish
       shell: bash
       run: |
-        cp ./LICENSE ${{ inputs.package }}
-        cp -f ${{ inputs.package }}/npm/README.md ${{ inputs.package }}/
+        cp ./LICENSE ${{ inputs.package_dir }}
+        cp -f ${{ inputs.package_dir }}/npm/README.md ${{ inputs.package_dir }}/
 
     - name: List package
       shell: bash
       run: |
-        echo "List '@${{ inputs.scope }}/${{ inputs.package }}' package"
-        ls -al -R ${{ inputs.package }}/dist
+        echo "List '${{ steps.prepare.outputs.package_name }}' package"
+        ls -al -R ${{ inputs.package_dir }}/dist
 
     - name: Publish package new version
       if: steps.check_version.outputs.deploy_mode == 'publish'
       shell: bash
+      working-directory: ${{ inputs.package_dir }}
       env:
         NPM_TOKEN: ${{ inputs.api_token }}
       run: |
-        echo "Publish '@${{ inputs.scope }}/${{ inputs.package }}' package"
+        echo "Publish '${{ steps.prepare.outputs.package_name }}' package"
         npm set "//registry.npmjs.org/:_authToken=${NPM_TOKEN}"
         if [ -z "${NPM_TOKEN}" -a "${{ inputs.dry_run }}" == "true" ]; then
           echo "Warning: An NPM access token is required for authentication and has not been provided."
         else
           npm whoami
         fi
-        cd ${{ inputs.package }}/
+        
         if [ "${{ inputs.dry_run }}" == "false" ]; then
           dry_run_option=""
         else
@@ -117,12 +123,12 @@ runs:
     - name: Promote package distribution tag to 'latest'
       if: inputs.dry_run == 'false' && steps.check_version.outputs.deploy_mode == 'promote'
       shell: bash
+      working-directory: ${{ inputs.package_dir }}
       env:
         NPM_TOKEN: ${{ inputs.api_token }}
       run: |
-        echo "Publish '@${{ inputs.scope }}/${{ inputs.package }}' package"
+        echo "Promote '${{ steps.prepare.outputs.package_name }}' package version '${{ steps.prepare.outputs.package_local_version }}' from 'next' to 'latest'"
         npm set "//registry.npmjs.org/:_authToken=${NPM_TOKEN}"
         npm whoami
-        cd ${{ inputs.package }}/
-        npm dist-tag add @${{ inputs.scope }}/${{ inputs.package }}@${{ steps.check_version.outputs.package_version }} latest
-        npm dist-tag rm @${{ inputs.scope }}/${{ inputs.package }}@${{ steps.check_version.outputs.package_version }} next
+        npm dist-tag add ${{ steps.prepare.outputs.package_name }}"@${{ steps.prepare.outputs.package_local_version }} latest
+        npm dist-tag rm ${{ steps.prepare.outputs.package_name }}"@${{ steps.prepare.outputs.package_local_version }} next
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -617,7 +617,7 @@ jobs:
         uses: ./.github/workflows/actions/publish-npm-package
         with:
           dry_run: "true"
-          package: ${{ matrix.package }}
+          package_dir: ${{ matrix.package }}
           scope: ${{ matrix.scope }}
           access: ${{ matrix.access }}
           api_token: ${{ secrets[matrix.api_token_secret_name] }}
diff --git a/.github/workflows/manual-publish-npm.yml b/.github/workflows/manual-publish-npm.yml
@@ -65,7 +65,7 @@ jobs:
         uses: ./.github/workflows/actions/publish-npm-package
         with:
           dry_run: ${{ inputs.dry_run }}
-          package: ${{ matrix.package }}
+          package_dir: ${{ matrix.package }}
           scope: ${{ matrix.scope }}
           tag: ${{ matrix.tag }}
           access: ${{ matrix.access }}
diff --git a/.github/workflows/pre-release.yml b/.github/workflows/pre-release.yml
@@ -345,7 +345,7 @@ jobs:
         uses: ./.github/workflows/actions/publish-npm-package
         with:
           dry_run: "false"
-          package: ${{ matrix.package }}
+          package_dir: ${{ matrix.package }}
           scope: ${{ matrix.scope }}
           tag: next
           access: ${{ matrix.access }}
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -277,7 +277,7 @@ jobs:
         uses: ./.github/workflows/actions/publish-npm-package
         with:
           dry_run: "false"
-          package: ${{ matrix.package }}
+          package_dir: ${{ matrix.package }}
           scope: ${{ matrix.scope }}
           tag: latest
           access: ${{ matrix.access }}
