@semantic-release/github 11.0.0 → 11.0.2

package/README.md

@@ -19,6 +19,10 @@
 
 ## Install
 
+> [!TIP]
+> You do not need to directly depend on this package if you are using `semantic-release`.
+> `semantic-release` already depends on this package, and defining your own direct dependency can result in conflicts when you update `semantic-release`.
+
 ```bash
 $ npm install @semantic-release/github -D
 ```
@@ -185,7 +189,7 @@ The `successComment` `This ${issue.pull_request ? 'pull request' : 'issue'} is i
 
 #### successCommentCondition
 
-The message for the issue comments is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:
+A [Lodash template](https://lodash.com/docs#template) string that should evaluate to a truthy or falsy variable. The following variables are available:
 
 | Parameter     | Description                                                                                                                                                    |
 | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -226,7 +230,7 @@ The `failComment` `This release from branch ${branch.name} had failed due to the
 
 #### failCommentCondition
 
-The message for the issue content is generated with [Lodash template](https://lodash.com/docs#template). The following variables are available:
+A [Lodash template](https://lodash.com/docs#template) string that should evaluate to a truthy or falsy variable. The following variables are available:
 
 | Parameter     | Description                                                                                                                                                                                                                                                                                                                                                                       |
 | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

package/lib/success.js

@@ -88,7 +88,7 @@ export default async function success(pluginConfig, context, { Octokit }) {
       for (const { nodes, pageInfo } of responseAssociatedPRs) {
         if (nodes.length === 0) continue;
 
-        responsePRs.push(...buildIssuesOrPRsFromResponseNode(nodes, "PR"));
+        responsePRs.push(...buildIssuesOrPRsFromResponseNode(nodes));
         if (pageInfo.hasNextPage) {
           let cursor = pageInfo.endCursor;
           let hasNextPage = true;
@@ -171,7 +171,7 @@ export default async function success(pluginConfig, context, { Octokit }) {
     if (!isEmpty(parsedIssues)) {
       const uniqueParsedIssues = uniqBy(flatten(parsedIssues), "number");
 
-      // Get relatedIssues
+      // Get relatedIssues (or relatedPRs i.e. Issues/PRs that are closed by an associatedPR)
       issues = await inChunks(uniqueParsedIssues, 100, async (chunk) => {
         const { repository } = await octokit.graphql(
           buildRelatedIssuesQuery(chunk.map((issue) => issue.number)),
@@ -360,6 +360,7 @@ async function inChunks(items, chunkSize, callback) {
  * Fields common accross PRs and Issue
  */
 const baseFields = `
+  __typename
   id
   title
   body
@@ -420,8 +421,25 @@ function buildRelatedIssuesQuery(numbers) {
       repository(owner: $owner, name: $repo) {
         ${numbers
           .map((num) => {
-            return `issue${num}: issue(number: ${num}) {
-              ${baseFields}
+            return `issue${num}: issueOrPullRequest(number: ${num}) {
+              ... on Issue {
+                ${baseFields}
+              }
+              ... on PullRequest {
+                ${baseFields}
+                mergeable
+                changedFiles
+                mergedAt
+                isDraft
+                mergedBy {
+                  login
+                  avatarUrl
+                  url
+                }
+                commits {
+                  totalCount
+                }
+              }
             }`;
           })
           .join("")}
@@ -513,10 +531,9 @@ const loadSingleCommitAssociatedPRs = `#graphql
 /**
  * Build associatedPRs or RelatedIssues object (into issue-like object with `pull_request` property) from the GraphQL repository response
  * @param {object} responseNodes
- * @param {"ISSUE" | "PR"} type
  * @returns {object[]}
  */
-function buildIssuesOrPRsFromResponseNode(responseNodes, type = "ISSUE") {
+function buildIssuesOrPRsFromResponseNode(responseNodes) {
   const resultArray = [];
   for (const node of responseNodes) {
     let baseProps = {
@@ -569,7 +586,7 @@ function buildIssuesOrPRsFromResponseNode(responseNodes, type = "ISSUE") {
 
     let result = baseProps;
 
-    if (type === "PR") {
+    if (node.__typename === "PullRequest") {
       const prProps = {
         pull_request: true,
         mergeable: node.mergeable,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@semantic-release/github",
   "description": "semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues",
-  "version": "11.0.0",
+  "version": "11.0.2",
   "type": "module",
   "author": "Pierre Vanduynslager (https://twitter.com/@pvdlg_)",
   "ava": {
@@ -23,9 +23,9 @@
   ],
   "dependencies": {
     "@octokit/core": "^6.0.0",
-    "@octokit/plugin-paginate-rest": "^11.0.0",
+    "@octokit/plugin-paginate-rest": "^12.0.0",
     "@octokit/plugin-retry": "^7.0.0",
-    "@octokit/plugin-throttling": "^9.0.0",
+    "@octokit/plugin-throttling": "^10.0.0",
     "@semantic-release/error": "^4.0.0",
     "aggregate-error": "^5.0.0",
     "debug": "^4.3.4",
@@ -40,18 +40,18 @@
     "url-join": "^5.0.0"
   },
   "devDependencies": {
-    "ava": "6.1.3",
-    "c8": "10.1.2",
+    "ava": "6.2.0",
+    "c8": "10.1.3",
     "cpy": "11.1.0",
     "cz-conventional-changelog": "3.3.0",
     "fetch-mock": "npm:@gr2m/fetch-mock@9.11.0-pull-request-644.1",
     "lockfile-lint": "4.14.0",
     "ls-engines": "0.9.3",
-    "npm-run-all2": "6.2.3",
-    "prettier": "3.3.3",
-    "publint": "0.2.11",
-    "semantic-release": "24.1.1",
-    "sinon": "19.0.2",
+    "npm-run-all2": "7.0.2",
+    "prettier": "3.5.3",
+    "publint": "0.3.12",
+    "semantic-release": "24.2.3",
+    "sinon": "20.0.0",
     "tempy": "3.1.0"
   },
   "engines": {
@@ -127,5 +127,5 @@
       "github>semantic-release/.github:renovate-config"
     ]
   },
-  "packageManager": "npm@10.8.3"
+  "packageManager": "npm@11.3.0"
 }