update pkg.pr.new script

Author: ota-meshi

.github/workflows/pkg.pr.new-comment.yml

@@ -0,0 +1,36 @@
+name: Update pkg.pr.new comment
+
+on:
+  workflow_run:
+    workflows: [Publish to pkg.pr.new]
+    types:
+      - completed
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  build:
+    if: github.repository == 'ota-meshi/eslint-plugin-astro'
+    name: Update comment
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: output
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          run-id: ${{ github.event.workflow_run.id }}
+      - run: ls -R .
+      - name: Post or update comment
+        uses: actions/github-script@v7
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const fs = require('fs');
+            const output = JSON.parse(fs.readFileSync('output.json', 'utf8'));
+            const { default: process } = await import('${{ github.workspace }}/tools/pkg.pr.new-comment.mjs')
+
+            await process({github, context, core, output})

.github/workflows/pkg.pr.new.yml

@@ -8,6 +8,7 @@ on:
 
 jobs:
   build:
+    if: github.repository == 'ota-meshi/eslint-plugin-astro'
     runs-on: ubuntu-latest
 
     steps:
@@ -18,12 +19,24 @@ jobs:
       - name: Build
         run: npm run build
       - run: npx pkg-pr-new publish --json output.json --comment=off
-      - uses: actions/github-script@v7
+      - name: Add metadata to output
+        uses: actions/github-script@v7
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
             const fs = require('fs');
             const output = JSON.parse(fs.readFileSync('output.json', 'utf8'));
-            const { default: process } = await import('${{ github.workspace }}/.github/workflows/pkg.pr.new-comment.mjs')
+            output.number = context.issue.number;
+            output.event_name = context.eventName;
+            output.ref = context.ref;
+            output.sha = context.eventName === 'pull_request'
+              ? context.payload.pull_request.head.sha
+              : context.payload.after;
+            fs.writeFileSync('output.json', JSON.stringify(output), 'utf8');
+      - name: Upload output
+        uses: actions/upload-artifact@v4
+        with:
+          name: output
+          path: ./output.json
 
-            await process({github, context, core, output})
+      - run: ls -R .

package.json

@@ -77,6 +77,7 @@
     "eslint": ">=8.57.0"
   },
   "devDependencies": {
+    "@actions/github": "^6.0.0",
     "@astrojs/compiler": "^2.0.0",
     "@astrojs/mdx": "^4.0.0",
     "@astrojs/svelte": "^7.0.0",

.github/workflows/pkg.pr.new-comment.mjs renamed to tools/pkg.pr.new-comment.mjs

@@ -1,14 +1,20 @@
 /**
  * Used in `/.github/workflows/pkg.pr.new.yml`
  */
+/**
+ * @param {object} params
+ * @param {import('@actions/github/lib/utils').GitHub} params.github
+ * @param {import('@actions/github/lib/context').Context} params.context
+ * @param {object} params.output
+ * @param {string} params.output.sha
+ * @param {string} params.output.number
+ * @param {Array<{name: string, url: string}>} params.output.packages
+ */
 export default async function ({ github, context, output }) {
   // eslint-disable-next-line no-console -- For debugging on github actions.
   console.log("pkg-pr-new publish output:", JSON.stringify(output))
 
-  const sha =
-    context.eventName === "pull_request"
-      ? context.payload.pull_request.head.sha
-      : context.payload.after
+  const sha = output.sha
   const commitUrl = `https://github.com/${context.repo.owner}/${context.repo.repo}/commit/${sha}`
 
   const pullRequestNumber = await getPullRequestNumber()
@@ -21,17 +27,15 @@ export default async function ({ github, context, output }) {
     const repoPath = `/${context.repo.owner}/${context.repo.repo}/`
     normalizedUrl = normalizedUrl.replace(repoPath, "/")
 
-    return {
-      name: p.name,
-      url: normalizedUrl,
-    }
+    return { name: p.name, url: normalizedUrl }
   })
 
   const botCommentIdentifier = "<!-- posted by pkg.pr.new-comment.mjs -->"
 
   const onlineUrl = new URL(
     "https://eslint-online-playground.netlify.app/#eslint-plugin-astro",
   )
+  /** @type {Record<string,string>} */
   const overrideDeps = {}
   for (const p of packages) {
     overrideDeps[p.name] = p.url
@@ -71,48 +75,37 @@ ${packages.map((p) => `- ${p.name}: ${p.url}`).join("\n")}
   /**
    * Get the pull request number from the context.
    */
-  async function getPullRequestNumber() {
-    if (context.eventName === "pull_request") {
-      if (context.issue.number) {
-        return context.issue.number
-      }
-    } else if (context.eventName === "push") {
-      const pullRequests = await github.rest.pulls.list({
-        owner: context.repo.owner,
-        repo: context.repo.repo,
-        state: "open",
-        head: `${context.repo.owner}:${context.ref.replace("refs/heads/", "")}`,
-      })
-
-      if (pullRequests.data.length > 0) {
-        return pullRequests.data[0].number
-      }
-    }
-    return null
+  function getPullRequestNumber() {
+    return output.number
   }
 
   /**
    * Find the bot comment in the pull request.
+   * @param {string} issueNumber The pull request number.
    */
   async function findBotComment(issueNumber) {
     if (!issueNumber) return null
+    // @ts-expect-error -- The ID defined in the GitHub API.
     const comments = await github.rest.issues.listComments({
       owner: context.repo.owner,
       repo: context.repo.repo,
       // eslint-disable-next-line camelcase -- The ID defined in the GitHub API.
       issue_number: issueNumber,
     })
+    // @ts-expect-error
     return comments.data.find((comment) =>
       comment.body.includes(botCommentIdentifier),
     )
   }
 
   /**
    * Create or update the bot comment in the pull request.
+   * @param {string} issueNumber The pull request number.
    */
   async function createOrUpdateComment(issueNumber) {
     const existingComment = await findBotComment(issueNumber)
     if (existingComment) {
+      // @ts-expect-error -- The ID defined in the GitHub API.
       await github.rest.issues.updateComment({
         owner: context.repo.owner,
         repo: context.repo.repo,
@@ -121,6 +114,7 @@ ${packages.map((p) => `- ${p.name}: ${p.url}`).join("\n")}
         body,
       })
     } else {
+      // @ts-expect-error -- The ID defined in the GitHub API.
       await github.rest.issues.createComment({
         // eslint-disable-next-line camelcase -- The ID defined in the GitHub API.
         issue_number: issueNumber,