Merge pull request #916 from semantic-release/add/warn

babblebey · web-flow · commit b6ed55ed8636 · 2024-09-24T21:00:55.000+01:00
chore(deps): bump minimum peer dependency bound with `semantic-release`
diff --git a/README.md b/README.md
diff --git a/lib/fail.js b/lib/fail.js
@@ -32,8 +32,7 @@ export default async function fail(pluginConfig, context, { Octokit }) {
 
   if (failComment === false || failTitle === false) {
     logger.log("Skip issue creation.");
-    // TODO: use logger.warn() instead of logger.log()
-    logger.log(
+    logger.warn(
       `DEPRECATION: 'false' for 'failComment' or 'failTitle' is deprecated and will be removed in a future major version. Use 'failCommentCondition' instead.`,
     );
   } else if (failCommentCondition === false) {
diff --git a/lib/success.js b/lib/success.js
@@ -62,8 +62,7 @@ export default async function success(pluginConfig, context, { Octokit }) {
       logger.log("No commits found in release");
     }
     logger.log("Skip commenting on issues and pull requests.");
-    // TODO: use logger.warn() instead of logger.log()
-    logger.log(
+    logger.warn(
       `DEPRECATION: 'false' for 'successComment' is deprecated and will be removed in a future major version. Use 'successCommentCondition' instead.`,
     );
   } else if (successCommentCondition === false) {
@@ -387,6 +386,8 @@ const baseFields = `
       url
       name
       color
+      description
+      isDefault
     }
   }
   milestone {
@@ -522,7 +523,16 @@ function buildIssuesOrPRsFromResponseNode(responseNodes, type = "ISSUE") {
       number: node.number,
       title: node.title,
       body: node.body,
-      labels: node.labels?.nodes.map((label) => label.name),
+      labels: node.labels?.nodes.map((label) => {
+        return {
+          id: label.id,
+          url: label.url,
+          name: label.name,
+          color: label.color,
+          description: label.description,
+          default: label.isDefault,
+        };
+      }),
       html_url: node.url,
       created_at: node.createdAt,
       updated_at: node.updatedAt,
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -101,7 +101,7 @@
     ]
   },
   "peerDependencies": {
-    "semantic-release": ">=20.1.0"
+    "semantic-release": ">=24.1.0"
   },
   "publishConfig": {
     "access": "public",
diff --git a/test/add-channel.test.js b/test/add-channel.test.js
@@ -12,7 +12,12 @@ test.beforeEach((t) => {
   // Mock logger
   t.context.log = sinon.stub();
   t.context.error = sinon.stub();
-  t.context.logger = { log: t.context.log, error: t.context.error };
+  t.context.warn = sinon.stub();
+  t.context.logger = {
+    log: t.context.log,
+    error: t.context.error,
+    warn: t.context.warn,
+  };
 });
 
 test("Update a release", async (t) => {
diff --git a/test/fail.test.js b/test/fail.test.js
@@ -14,7 +14,12 @@ test.beforeEach((t) => {
   // Mock logger
   t.context.log = sinon.stub();
   t.context.error = sinon.stub();
-  t.context.logger = { log: t.context.log, error: t.context.error };
+  t.context.warn = sinon.stub();
+  t.context.logger = {
+    log: t.context.log,
+    error: t.context.error,
+    warn: t.context.warn,
+  };
 });
 
 test("Open a new issue with the list of errors", async (t) => {
diff --git a/test/find-sr-issue.test.js b/test/find-sr-issue.test.js
@@ -10,7 +10,12 @@ test.beforeEach((t) => {
   // Mock logger
   t.context.log = sinon.stub();
   t.context.error = sinon.stub();
-  t.context.logger = { log: t.context.log, error: t.context.error };
+  t.context.warn = sinon.stub();
+  t.context.logger = {
+    log: t.context.log,
+    error: t.context.error,
+    warn: t.context.warn,
+  };
 });
 
 test("Filter out issues without ID", async (t) => {
diff --git a/test/integration.test.js b/test/integration.test.js
@@ -14,7 +14,12 @@ test.beforeEach(async (t) => {
   // Stub the logger
   t.context.log = sinon.stub();
   t.context.error = sinon.stub();
-  t.context.logger = { log: t.context.log, error: t.context.error };
+  t.context.warn = sinon.stub();
+  t.context.logger = {
+    log: t.context.log,
+    error: t.context.error,
+    warn: t.context.warn,
+  };
 });
 
 test("Verify GitHub auth", async (t) => {
diff --git a/test/publish.test.js b/test/publish.test.js
@@ -15,7 +15,12 @@ test.beforeEach((t) => {
   // Mock logger
   t.context.log = sinon.stub();
   t.context.error = sinon.stub();
-  t.context.logger = { log: t.context.log, error: t.context.error };
+  t.context.warn = sinon.stub();
+  t.context.logger = {
+    log: t.context.log,
+    error: t.context.error,
+    warn: t.context.warn,
+  };
 });
 
 test("Publish a release without creating discussion", async (t) => {
diff --git a/test/success.test.js b/test/success.test.js
@@ -16,7 +16,12 @@ test.beforeEach((t) => {
   // Mock logger
   t.context.log = sinon.stub();
   t.context.error = sinon.stub();
-  t.context.logger = { log: t.context.log, error: t.context.error };
+  t.context.warn = sinon.stub();
+  t.context.logger = {
+    log: t.context.log,
+    error: t.context.error,
+    warn: t.context.warn,
+  };
 });
 
 test("Add comment and labels to PRs associated with release commits and issues solved by PR/commits comments", async (t) => {
@@ -125,6 +130,8 @@ test("Add comment and labels to PRs associated with release commits and issues s
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
@@ -159,6 +166,8 @@ test("Add comment and labels to PRs associated with release commits and issues s
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
@@ -432,6 +441,8 @@ test("Add comment and labels to PRs associated with release commits and issues (
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
@@ -466,6 +477,8 @@ test("Add comment and labels to PRs associated with release commits and issues (
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
@@ -685,6 +698,8 @@ test("Add comment and labels to PRs associated with release commits and issues c
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
@@ -719,6 +734,8 @@ test("Add comment and labels to PRs associated with release commits and issues c
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
@@ -1578,6 +1595,8 @@ test("Do not add comment and labels to PR/issues from other repo", async (t) =>
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
@@ -1758,6 +1777,8 @@ test("Ignore missing and forbidden issues/PRs", async (t) => {
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
@@ -1792,6 +1813,8 @@ test("Ignore missing and forbidden issues/PRs", async (t) => {
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
@@ -1826,6 +1849,8 @@ test("Ignore missing and forbidden issues/PRs", async (t) => {
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
@@ -3478,7 +3503,7 @@ test('Add comment and label to found issues/associatedPR using the "successComme
     failTitle,
     // Issues with the label "semantic-release-relevant" will be commented and labeled
     successCommentCondition:
-      "<% return issue.labels.includes('semantic-release-relevant'); %>",
+      "<% return issue.labels?.some((label) => { return label.name === ('semantic-release-relevant'); }); %>",
   };
   const options = {
     repositoryUrl: `https://github.com/${owner}/${repo}.git`,
@@ -3527,6 +3552,8 @@ test('Add comment and label to found issues/associatedPR using the "successComme
             url: "https://github.com/babblebey/sr-github/labels/released",
             name: "semantic-release-relevant",
             color: "ededed",
+            description: "This issue is relevant to semantic-release",
+            isDefault: false,
           },
         ],
       },
@@ -3575,6 +3602,8 @@ test('Add comment and label to found issues/associatedPR using the "successComme
             url: "https://github.com/babblebey/sr-github/labels/released",
             name: "released",
             color: "ededed",
+            description: "this is a label description",
+            isDefault: false,
           },
         ],
       },
@@ -3773,6 +3802,8 @@ test('Does not comment/label associatedPR and relatedIssues created by "Bots"',
             url: "label_url",
             name: "label_name",
             color: "ededed",
+            description: "this is a label description",
+            isDefault: false,
           },
         ],
       },
@@ -3819,6 +3850,8 @@ test('Does not comment/label associatedPR and relatedIssues created by "Bots"',
             url: "label_url",
             name: "label_name",
             color: "ededed",
+            description: "this is a label description",
+            isDefault: false,
           },
         ],
       },
@@ -3910,6 +3943,8 @@ test('Does not comment/label associatedPR and relatedIssues created by "Bots"',
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
@@ -3944,6 +3979,8 @@ test('Does not comment/label associatedPR and relatedIssues created by "Bots"',
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
@@ -4158,6 +4195,8 @@ test('Does not comment/label "associatedPR" when "successCommentCondition" disab
                     url: "label_url",
                     name: "label_name",
                     color: "ededed",
+                    description: "this is a label description",
+                    isDefault: false,
                   },
                 ],
               },
diff --git a/test/verify.test.js b/test/verify.test.js
@@ -12,7 +12,12 @@ test.beforeEach((t) => {
   // Mock logger
   t.context.log = sinon.stub();
   t.context.error = sinon.stub();
-  t.context.logger = { log: t.context.log, error: t.context.error };
+  t.context.warn = sinon.stub();
+  t.context.logger = {
+    log: t.context.log,
+    error: t.context.error,
+    warn: t.context.warn,
+  };
 });
 
 test("Verify package, token and repository access", async (t) => {

Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@`
`101`	`101`	`]`
`102`	`102`	`},`
`103`	`103`	`"peerDependencies": {`
`104`		`- "semantic-release": ">=20.1.0"`
	`104`	`+ "semantic-release": ">=24.1.0"`
`105`	`105`	`},`
`106`	`106`	`"publishConfig": {`
`107`	`107`	`"access": "public",`