@semantic-release/github 10.1.2 → 10.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/lib/definitions/errors.js +0 -11
- package/lib/get-fail-comment.js +2 -2
- package/lib/verify.js +0 -27
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -95,8 +95,8 @@ When using the _GITHUB_TOKEN_, the **minimum required permissions** are:
|
|
|
95
95
|
| `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}\` : "" %>']- |
|
|
96
96
|
| `addReleases` | Will add release links to the GitHub Release. Can be `false`, `"bottom"` or `"top"`. See [addReleases](#addReleases). | `false` |
|
|
97
97
|
| `draftRelease` | A boolean indicating if a GitHub Draft Release should be created instead of publishing an actual GitHub Release. | `false` |
|
|
98
|
-
| `releaseNameTemplate` | A [Lodash template](https://lodash.com/docs#template) to customize the github release's name | `<%=
|
|
99
|
-
| `releaseBodyTemplate` | A [Lodash template](https://lodash.com/docs#template) to customize the github release's body | `<%=
|
|
98
|
+
| `releaseNameTemplate` | A [Lodash template](https://lodash.com/docs#template) to customize the github release's name | `<%= nextRelease.name %>` |
|
|
99
|
+
| `releaseBodyTemplate` | A [Lodash template](https://lodash.com/docs#template) to customize the github release's body | `<%= nextRelease.notes %>` |
|
|
100
100
|
| `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` |
|
|
101
101
|
|
|
102
102
|
#### proxy
|
|
@@ -139,17 +139,6 @@ By default the \`repositoryUrl\` option is retrieved from the \`repository\` pro
|
|
|
139
139
|
};
|
|
140
140
|
}
|
|
141
141
|
|
|
142
|
-
export function EMISMATCHGITHUBURL() {
|
|
143
|
-
return {
|
|
144
|
-
message: "The git repository URL mismatches the GitHub URL.",
|
|
145
|
-
details: `The **semantic-release** \`repositoryUrl\` option must match your GitHub URL with the format \`<GitHub_or_GHE_URL>/<owner>/<repo>.git\`.
|
|
146
|
-
|
|
147
|
-
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.
|
|
148
|
-
|
|
149
|
-
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.`,
|
|
150
|
-
};
|
|
151
|
-
}
|
|
152
|
-
|
|
153
142
|
export function EINVALIDPROXY({ proxy }) {
|
|
154
143
|
return {
|
|
155
144
|
message: "Invalid `proxy` option.",
|
package/lib/get-fail-comment.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
const HOME_URL = "https://github.com/semantic-release/semantic-release";
|
|
2
|
-
const FAQ_URL = `${HOME_URL}/blob/
|
|
2
|
+
const FAQ_URL = `${HOME_URL}/blob/master/docs/support/FAQ.md`;
|
|
3
3
|
const GET_HELP_URL = `${HOME_URL}#get-help`;
|
|
4
|
-
const USAGE_DOC_URL = `${HOME_URL}/blob/
|
|
4
|
+
const USAGE_DOC_URL = `${HOME_URL}/blob/master/docs/usage/README.md`;
|
|
5
5
|
const NEW_ISSUE_URL = `${HOME_URL}/issues/new`;
|
|
6
6
|
|
|
7
7
|
const formatError = (error) => `### ${error.message}
|
package/lib/verify.js
CHANGED
|
@@ -144,33 +144,6 @@ export default async function verify(pluginConfig, context, { Octokit }) {
|
|
|
144
144
|
}
|
|
145
145
|
}
|
|
146
146
|
|
|
147
|
-
// Verify if Repository Name wasn't changed
|
|
148
|
-
if (
|
|
149
|
-
owner &&
|
|
150
|
-
repo &&
|
|
151
|
-
githubToken &&
|
|
152
|
-
!errors.find(({ code }) => code === "EINVALIDPROXY") &&
|
|
153
|
-
!errors.find(({ code }) => code === "EMISSINGREPO")
|
|
154
|
-
) {
|
|
155
|
-
const octokit = new Octokit(
|
|
156
|
-
toOctokitOptions({
|
|
157
|
-
githubToken,
|
|
158
|
-
githubUrl,
|
|
159
|
-
githubApiPathPrefix,
|
|
160
|
-
githubApiUrl,
|
|
161
|
-
proxy,
|
|
162
|
-
}),
|
|
163
|
-
);
|
|
164
|
-
|
|
165
|
-
const {
|
|
166
|
-
status,
|
|
167
|
-
data: { clone_url },
|
|
168
|
-
} = await octokit.request("GET /repos/{owner}/{repo}", { owner, repo });
|
|
169
|
-
if (status !== 200 || repositoryUrl !== clone_url) {
|
|
170
|
-
errors.push(getError("EMISMATCHGITHUBURL"));
|
|
171
|
-
}
|
|
172
|
-
}
|
|
173
|
-
|
|
174
147
|
if (!githubToken) {
|
|
175
148
|
errors.push(getError("ENOGHTOKEN", { owner, repo }));
|
|
176
149
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@semantic-release/github",
|
|
3
3
|
"description": "semantic-release plugin to publish a GitHub release and comment on released Pull Requests/Issues",
|
|
4
|
-
"version": "10.1.
|
|
4
|
+
"version": "10.1.4",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"author": "Pierre Vanduynslager (https://twitter.com/@pvdlg_)",
|
|
7
7
|
"ava": {
|
|
@@ -42,11 +42,11 @@
|
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"ava": "6.1.3",
|
|
44
44
|
"c8": "10.1.2",
|
|
45
|
-
"cpy": "11.0
|
|
45
|
+
"cpy": "11.1.0",
|
|
46
46
|
"cz-conventional-changelog": "3.3.0",
|
|
47
47
|
"fetch-mock": "npm:@gr2m/fetch-mock@9.11.0-pull-request-644.1",
|
|
48
48
|
"lockfile-lint": "4.14.0",
|
|
49
|
-
"ls-engines": "0.9.
|
|
49
|
+
"ls-engines": "0.9.3",
|
|
50
50
|
"npm-run-all2": "6.2.2",
|
|
51
51
|
"prettier": "3.3.3",
|
|
52
52
|
"publint": "0.2.9",
|