chore: implement pkg-pr-new (#592)

pedrobonamin · web-flow · commit a0804cd50efb · 2026-02-19T08:53:14.000+01:00
* chore: try pkg-pr-new

* change path

* fix: publish only 1 plugin

* release two packages

* fix: update comment

* fix: add details element to comment

* fix: identify changed packages

* fix: publish with changesets

* fix: remove changeset

* update no changes message

* fix: remove issue write permission

* chore: add section in contributing readme to explain usage of pkg-pr-new
diff --git a/.github/workflows/pkg-pr-new.yml b/.github/workflows/pkg-pr-new.yml
@@ -0,0 +1,222 @@
+name: Publish
+on:
+  pull_request:
+    types: [opened, synchronize, labeled, reopened]
+
+concurrency:  
+  group: pkg-pr-new-${{ github.event.pull_request.number }}  
+  cancel-in-progress: true  
+
+permissions:
+  contents: read
+  pull-requests: write
+
+jobs:
+  publish:
+    if: >
+      github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'trigger: preview')
+
+    runs-on: ubuntu-latest
+    env:
+      TURBO_TOKEN: ${{ secrets.TURBO_TOKEN }}
+      TURBO_TEAM: ${{ vars.TURBO_TEAM }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+      - uses: ./.github/actions/setup
+
+      - name: Build
+        run: pnpm turbo run build --filter='!./dev/*'
+
+      - name: Detect changed plugin packages from changesets
+        id: changed-packages
+        run: |
+          mapfile -t changeset_files < <(
+            git diff --name-only "origin/${{ github.base_ref }}"...HEAD -- '.changeset/*.md'
+          )
+
+          filtered_changeset_files=()
+          for file in "${changeset_files[@]}"; do
+            if [[ "$file" == ".changeset/README.md" ]]; then
+              continue
+            fi
+            if [[ "$file" == .changeset/*.md ]]; then
+              filtered_changeset_files+=("$file")
+            fi
+          done
+          changeset_files=("${filtered_changeset_files[@]}")
+
+          if [ ${#changeset_files[@]} -eq 0 ]; then
+            echo "has_changed_packages=false" >> "$GITHUB_OUTPUT"
+            echo "package_paths=" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          parser_script="$(mktemp)"
+          cat > "$parser_script" <<'NODE'
+          const fs = require("node:fs")
+          const files = process.argv.slice(2)
+          const paths = new Set()
+
+          for (const file of files) {
+            const content = fs.readFileSync(file, "utf8")
+            const match = content.match(/^---\n([\s\S]*?)\n---/)
+            if (!match) continue
+
+            for (const line of match[1].split("\n")) {
+              const packageMatch = line.match(/^\s*['"]([^'"]+)['"]\s*:\s*(major|minor|patch)\s*$/)
+              if (!packageMatch) continue
+
+              const packageName = packageMatch[1]
+              let packagePath = null
+
+              if (packageName.startsWith("@sanity/")) {
+                packagePath = `./plugins/@sanity/${packageName.slice("@sanity/".length)}`
+              } else if (packageName.startsWith("sanity-plugin-")) {
+                packagePath = `./plugins/${packageName}`
+              }
+
+              if (packagePath && fs.existsSync(packagePath)) {
+                paths.add(packagePath)
+              }
+            }
+          }
+
+          for (const path of [...paths].sort()) {
+            console.log(path)
+          }
+          NODE
+
+          mapfile -t packages < <(node "$parser_script" "${changeset_files[@]}")
+          rm -f "$parser_script"
+
+          if [ ${#packages[@]} -eq 0 ]; then
+            echo "has_changed_packages=false" >> "$GITHUB_OUTPUT"
+            echo "package_paths=" >> "$GITHUB_OUTPUT"
+            exit 0
+          fi
+
+          echo "has_changed_packages=true" >> "$GITHUB_OUTPUT"
+          echo "package_paths=${packages[*]}" >> "$GITHUB_OUTPUT"
+
+      - name: Publish preview packages
+        if: steps.changed-packages.outputs.has_changed_packages == 'true'
+        run: pnpm dlx pkg-pr-new publish ${{ steps.changed-packages.outputs.package_paths }} --pnpm --no-template --comment=off --json output.json
+
+      - name: Post or update comment
+        uses: actions/github-script@v7
+        env:
+          HAS_CHANGED_PACKAGES: ${{ steps.changed-packages.outputs.has_changed_packages }}
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const fs = require('node:fs')
+
+            const hasChangedPackages = process.env.HAS_CHANGED_PACKAGES === 'true'
+            const output = hasChangedPackages
+              ? JSON.parse(fs.readFileSync('output.json', 'utf8'))
+              : {packages: []}
+
+            const PACKAGE_MANAGERS = [
+              {
+                name: 'pnpm',
+                installCommand: 'pnpm install',
+                logoUrl: 'https://avatars.githubusercontent.com/u/21320719?s=200&v=4',
+              },
+              {
+                name: 'npm',
+                installCommand: 'npm install',
+                logoUrl: 'https://avatars.githubusercontent.com/u/6078720?s=200&v=4',
+              },
+            ]
+
+            const BOT_COMMENT_IDENTIFIER = '<!-- pkg.pr.new -->'
+            const BACKTICKS = '```'
+
+            function renderPackages(pkgManager, pkgs) {
+              return pkgs
+                .map(
+                  (pkg) =>
+                    `##### :package: \`${pkg.name}\`
+            ${BACKTICKS}sh
+            ${pkgManager.installCommand} ${pkg.url}
+            ${BACKTICKS}
+            `,
+                )
+                .join('\n')
+            }
+
+            function renderInstallInstructions() {
+              return PACKAGE_MANAGERS.map(
+                (pkgManager) =>
+                  `<details${pkgManager.name === 'pnpm' ? ' open' : ''}>
+            <summary><img height="16" align="center" alt="${pkgManager.name} logo" src="${pkgManager.logoUrl}" /> <b>Using ${pkgManager.name}</b></summary>
+
+            ${renderPackages(pkgManager, output.packages)}
+
+            </details>
+            `,
+              ).join('\n')
+            }
+
+            const sha = context.payload.pull_request?.head?.sha ?? context.sha
+
+            const body = hasChangedPackages
+              ? `## Preview this PR with [pkg.pr.new](https://pkg.pr.new)
+
+            ${renderInstallInstructions()}
+
+            [View Commit](${`https://github.com/${context.repo.owner}/${context.repo.repo}/commit/${sha}`}) (${sha})
+
+            ${BOT_COMMENT_IDENTIFIER}
+            `
+              : `## Preview this PR with [pkg.pr.new](https://pkg.pr.new)
+
+            No packages were published, no changesets were found.
+
+            [View Commit](${`https://github.com/${context.repo.owner}/${context.repo.repo}/commit/${sha}`}) (${sha})
+
+            ${BOT_COMMENT_IDENTIFIER}
+            `
+
+            async function findBotComment(issueNumber) {
+              if (!issueNumber) return null
+              const comments = await github.rest.issues.listComments({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: issueNumber,
+              })
+              return comments.data.find((comment) => comment.body.includes(BOT_COMMENT_IDENTIFIER))
+            }
+
+            async function createOrUpdateComment(issueNumber) {
+              if (!issueNumber) {
+                console.log('No issue number provided. Cannot post or update comment.')
+                return
+              }
+
+              const existingComment = await findBotComment(issueNumber)
+              if (existingComment) {
+                await github.rest.issues.updateComment({
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  comment_id: existingComment.id,
+                  body,
+                })
+              } else {
+                await github.rest.issues.createComment({
+                  issue_number: issueNumber,
+                  owner: context.repo.owner,
+                  repo: context.repo.repo,
+                  body,
+                })
+              }
+            }
+
+            if (context.eventName === 'pull_request') {
+              await createOrUpdateComment(context.issue.number)
+            } else {
+              throw new Error('This job can only run for pull requests')
+            }
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -278,6 +278,39 @@ Commit the changeset file with your PR.
 
 This monorepo uses [Changesets](https://github.com/changesets/changesets) for version management and publishing.
 
+### Preview Packages in a PR (`pkg-pr-new`)
+
+You can publish preview versions of changed plugin packages directly from a PR using [`pkg.pr.new`](https://pkg.pr.new).
+
+#### How it is triggered
+
+The preview workflow runs on PR events **only when the PR has the `trigger: preview` label**.
+
+1. Open your PR
+2. Add the `trigger: preview` label
+3. Wait for the `Publish` workflow (`.github/workflows/pkg-pr-new.yml`) to finish
+
+#### What gets preview-published
+
+The workflow detects changed packages from `.changeset/*.md` files in your PR diff and publishes only matching plugin packages.
+
+- It ignores `.changeset/README.md`
+- It supports package names that map to:
+  - `@sanity/*` -> `plugins/@sanity/*`
+  - `sanity-plugin-*` -> `plugins/sanity-plugin-*`
+
+If no valid changesets are found, no packages are published.
+
+#### How to use the preview
+
+After the workflow runs, it posts (or updates) a PR comment titled **"Preview this PR with pkg.pr.new"** that includes install commands for each published package (for both `pnpm` and `npm`).
+
+Use the provided command in another project to test the preview package version, for example:
+
+```bash
+pnpm install <pkg.pr.new url from the PR comment>
+```
+
 ### Creating a Changeset
 
 When you make changes that should be released:
