Add pull request pre-release builds and publishing

Enhance CI workflow to automatically build and publish pre-release versions
for pull requests with versioning scheme including PR number, build number,
and commit hash. Add automatic PR comments to notify about published
pre-releases and update documentation.

Author: dahlia

.github/workflows/build.yaml

@@ -145,21 +145,34 @@ jobs:
     - uses: pnpm/action-setup@v4
       with:
         version: 10
-    - if: github.ref_type == 'branch'
+    - if: github.event_name == 'push' && github.ref_type == 'branch'
       run: |
         jq \
           --arg build "$GITHUB_RUN_NUMBER" \
           --arg commit "${GITHUB_SHA::8}" \
           '.version = .version + "-dev." + $build + "+" + $commit' \
           deno.json > deno.json.tmp
         mv deno.json.tmp deno.json
+      working-directory: ${{ github.workspace }}/fedify/
+    - if: github.event_name == 'pull_request'
+      run: |
         jq \
+          --arg pr_number "$PR_NUMBER" \
           --arg build "$GITHUB_RUN_NUMBER" \
           --arg commit "${GITHUB_SHA::8}" \
-          '.version = .version + "-dev." + $build + "+" + $commit' \
-          package.json > package.json.tmp
-        mv package.json.tmp package.json
+          '.version = .version + "-pr." + $pr_number + "." + $build + "+" + $commit' \
+          deno.json > deno.json.tmp
+        mv deno.json.tmp deno.json
       working-directory: ${{ github.workspace }}/fedify/
+      env:
+        PR_NUMBER: ${{ github.event.pull_request.number }}
+    - id: versioning
+      run: |
+        set -ex
+        echo version="$(jq -r .version deno.json)" >> $GITHUB_OUTPUT
+        echo short_version="$(jq -r .version deno.json | sed 's/[+].*//')" >> $GITHUB_OUTPUT
+      working-directory: ${{ github.workspace }}/fedify/
+    - run: deno task -r sync-version
     - if: github.ref_type == 'tag'
       run: |
         set -ex
@@ -202,29 +215,27 @@ jobs:
           fedify/fedify-fedify-*.tgz
           cli/fedify-cli-*
         generate_release_notes: false
-    - if: |
-        github.event_name == 'push' &&
-        github.ref_type == 'tag' || github.ref == 'refs/heads/main'
-      run: deno task publish --allow-dirty
+    - run: deno task publish --allow-dirty
       working-directory: ${{ github.workspace }}/fedify/
-    - if: |
-        github.event_name == 'push' &&
-        github.ref_type == 'tag' || github.ref == 'refs/heads/main'
-      run: deno task publish --allow-dirty
+    - run: deno task publish --allow-dirty
       working-directory: ${{ github.workspace }}/cli/
-    - if: |
-        github.event_name == 'push' &&
-        github.ref_type == 'tag' || github.ref == 'refs/heads/main'
-      run: |
+    - run: |
         set -ex
         npm config set //registry.npmjs.org/:_authToken "$NPM_AUTH_TOKEN"
         if [[ "$GITHUB_REF_TYPE" = "tag" ]]; then
           npm publish --provenance --access public fedify-fedify-*.tgz
+        elif [[ "$GITHUB_EVENT_NAME" = "pull_request" ]]; then
+          npm publish \
+            --provenance \
+            --access public \
+            --tag "pr-$PR_NUMBER" \
+            fedify-fedify-*.tgz
         else
           npm publish --provenance --access public --tag dev fedify-fedify-*.tgz
         fi
       env:
         NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+        PR_NUMBER: ${{ github.event.pull_request.number }}
       working-directory: ${{ github.workspace }}/fedify/
     - if: github.event_name == 'push' && github.ref_type == 'tag'
       run: |
@@ -234,6 +245,16 @@ jobs:
       env:
         NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
       working-directory: ${{ github.workspace }}/cli/
+    - if: github.event_name == 'pull_request'
+      uses: thollander/actions-comment-pull-request@v3
+      with:
+        message: |
+          The latest push to this pull request has been published to JSR and npm
+          as a pre-release:
+
+          - [`jsr:@fedify/fedify@${{ steps.versioning.outputs.version }}`](https://jsr.io/@fedify/fedify@${{ steps.versioning.outputs.version }})
+          - [`jsr:@fedify/cli@${{ steps.versioning.outputs.version }}`](https://jsr.io/@fedify/cli@${{ steps.versioning.outputs.version }})
+          - [`npm:@fedify/fedify@${{ steps.versioning.outputs.short_version }}`](https://www.npmjs.com/package/@fedify/fedify/v/${{ steps.versioning.outputs.short_version }})
 
   publish-examples-blog:
     if: github.event_name == 'push'

CONTRIBUTING.md

@@ -131,6 +131,16 @@ A patch set should include the following:
 
 Feature pull requests should target the *main* branch.
 
+### Pull request builds
+
+Each pull request is automatically built and published to the JSR and npm
+registries as a pre-release.  You can test the pull request by installing
+the pre-release version of the Fedify library.  The version number of
+the pre-release version consists of the base version number, the pull request
+number, the build number, and the commit hash, which looks like
+`1.2.3-pr.456.789+abcdef01`.  You can find the exact version number in
+the comment left by the build process in the pull request.
+
 
 Build
 -----