@semantic-release/github 10.1.3 → 10.1.5

package/README.md

@@ -95,8 +95,8 @@ When using the _GITHUB_TOKEN_, the **minimum required permissions** are:
 | `releasedLabels`         | The [labels](https://help.github.com/articles/about-labels) to add to each issue and pull request resolved by the release. Set to `false` to not add any label. See [releasedLabels](#releasedlabels). | `['released<%= nextRelease.channel ? \` on @\${nextRelease.channel}\` : "" %>']-                                                                     |
 | `addReleases`            | Will add release links to the GitHub Release. Can be `false`, `"bottom"` or `"top"`. See [addReleases](#addReleases).                                                                                  | `false`                                                                                                                                              |
 | `draftRelease`           | A boolean indicating if a GitHub Draft Release should be created instead of publishing an actual GitHub Release.                                                                                       | `false`                                                                                                                                              |
-| `releaseNameTemplate`    | A [Lodash template](https://lodash.com/docs#template) to customize the github release's name                                                                                                           | `<%= nextverison.name %>`                                                                                                                            |
-| `releaseBodyTemplate`    | A [Lodash template](https://lodash.com/docs#template) to customize the github release's body                                                                                                           | `<%= nextverison.notes %>`                                                                                                                           |
+| `releaseNameTemplate`    | A [Lodash template](https://lodash.com/docs#template) to customize the github release's name                                                                                                           | `<%= nextRelease.name %>`                                                                                                                            |
+| `releaseBodyTemplate`    | A [Lodash template](https://lodash.com/docs#template) to customize the github release's body                                                                                                           | `<%= nextRelease.notes %>`                                                                                                                           |
 | `discussionCategoryName` | The category name in which to create a linked discussion to the release. Set to `false` to disable creating discussion for a release.                                                                  | `false`                                                                                                                                              |
 
 #### proxy

package/lib/definitions/errors.js

@@ -139,6 +139,19 @@ By default the \`repositoryUrl\` option is retrieved from the \`repository\` pro
   };
 }
 
+export function EMISMATCHGITHUBURL({ repositoryUrl, clone_url }) {
+  return {
+    message: "The git repository URL mismatches the GitHub URL.",
+    details: `The **semantic-release** \`repositoryUrl\` option must have the same repository name and owner as the GitHub repo.
+
+Your configuration for the \`repositoryUrl\` option is \`${stringify(repositoryUrl)}\` and the \`clone_url\` of your GitHub repo is \`${stringify(clone_url)}\`.
+
+By default the \`repositoryUrl\` option is retrieved from the \`repository\` property of your \`package.json\` or the [git origin url](https://git-scm.com/book/en/v2/Git-Basics-Working-with-Remotes) of the repository cloned by your CI environment.
+
+Note: If you have recently changed your GitHub repository name or owner, update the value in **semantic-release** \`repositoryUrl\` option and the \`repository\` property of your \`package.json\` respectively to match the new GitHub URL.`,
+  };
+}
+
 export function EINVALIDPROXY({ proxy }) {
   return {
     message: "Invalid `proxy` option.",

package/lib/get-fail-comment.js

@@ -1,7 +1,7 @@
 const HOME_URL = "https://github.com/semantic-release/semantic-release";
-const FAQ_URL = `${HOME_URL}/blob/caribou/docs/support/FAQ.md`;
+const FAQ_URL = `${HOME_URL}/blob/master/docs/support/FAQ.md`;
 const GET_HELP_URL = `${HOME_URL}#get-help`;
-const USAGE_DOC_URL = `${HOME_URL}/blob/caribou/docs/usage/README.md`;
+const USAGE_DOC_URL = `${HOME_URL}/blob/master/docs/usage/README.md`;
 const NEW_ISSUE_URL = `${HOME_URL}/issues/new`;
 
 const formatError = (error) => `### ${error.message}

package/lib/verify.js

@@ -103,35 +103,34 @@ export default async function verify(pluginConfig, context, { Octokit }) {
         proxy,
       }),
     );
-
-    // https://github.com/semantic-release/github/issues/182
-    // Do not check for permissions in GitHub actions, as the provided token is an installation access token.
-    // octokit.request("GET /repos/{owner}/{repo}", {repo, owner}) does not return the "permissions" key in that case.
-    // But GitHub Actions have all permissions required for @semantic-release/github to work
-    if (env.GITHUB_ACTION) {
-      return;
-    }
-
     try {
       const {
-        data: {
-          permissions: { push },
-        },
+        data: { permissions, clone_url },
       } = await octokit.request("GET /repos/{owner}/{repo}", { repo, owner });
-      if (!push) {
+      // Verify if Repository Name wasn't changed
+      const parsedCloneUrl = parseGithubUrl(clone_url);
+      if (owner !== parsedCloneUrl.owner || repo !== parsedCloneUrl.repo) {
+        errors.push(
+          getError("EMISMATCHGITHUBURL", { repositoryUrl, clone_url }),
+        );
+      }
+
+      // https://github.com/semantic-release/github/issues/182
+      // Do not check for permissions in GitHub actions, as the provided token is an installation access token.
+      // octokit.request("GET /repos/{owner}/{repo}", {repo, owner}) does not return the "permissions" key in that case.
+      // But GitHub Actions have all permissions required for @semantic-release/github to work
+      if (!env.GITHUB_ACTION && !permissions?.push) {
         // If authenticated as GitHub App installation, `push` will always be false.
         // We send another request to check if current authentication is an installation.
         // Note: we cannot check if the installation has all required permissions, it's
         // up to the user to make sure it has
         if (
-          await octokit
+          !(await octokit
             .request("HEAD /installation/repositories", { per_page: 1 })
-            .catch(() => false)
+            .catch(() => false))
         ) {
-          return;
+          errors.push(getError("EGHNOPERMISSION", { owner, repo }));
         }
-
-        errors.push(getError("EGHNOPERMISSION", { owner, repo }));
       }
     } catch (error) {
       if (error.status === 401) {

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": "10.1.3",
+  "version": "10.1.5",
   "type": "module",
   "author": "Pierre Vanduynslager (https://twitter.com/@pvdlg_)",
   "ava": {
@@ -42,11 +42,11 @@
   "devDependencies": {
     "ava": "6.1.3",
     "c8": "10.1.2",
-    "cpy": "11.0.1",
+    "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.2",
+    "ls-engines": "0.9.3",
     "npm-run-all2": "6.2.2",
     "prettier": "3.3.3",
     "publint": "0.2.9",