@semantic-release/github 5.4.2 → 5.4.3
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/get-fail-comment.js +2 -2
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
| `verifyConditions` | Verify the presence and the validity of the authentication (set via [environment variables](#environment-variables)) and the [assets](#assets) option configuration. |
|
|
16
16
|
| `publish` | Publish a [GitHub release](https://help.github.com/articles/about-releases), optionally uploading file assets. |
|
|
17
17
|
| `success` | Add a comment to each [GitHub Issue](https://help.github.com/articles/about-issues) or [Pull Request](https://help.github.com/articles/about-pull-requests) resolved by the release and close issues previously open by the `fail` step. |
|
|
18
|
-
| `fail` | Open or update a [GitHub Issue](https://help.github.com/articles/about-issues) with
|
|
18
|
+
| `fail` | Open or update a [GitHub Issue](https://help.github.com/articles/about-issues) with information about the errors that caused the release to fail. |
|
|
19
19
|
|
|
20
20
|
## Install
|
|
21
21
|
|
|
@@ -158,7 +158,7 @@ The message for the issue content is generated with [Lodash template](https://lo
|
|
|
158
158
|
| Parameter | Description |
|
|
159
159
|
|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
160
160
|
| `branch` | The branch from which the release had failed. |
|
|
161
|
-
| `errors` | An `Array` of [SemanticReleaseError](https://github.com/semantic-release/error). Each error has the `message`, `code`, `pluginName` and `details` properties.<br>`pluginName` contains the package name of the plugin that threw the error.<br>`details` contains a
|
|
161
|
+
| `errors` | An `Array` of [SemanticReleaseError](https://github.com/semantic-release/error). Each error has the `message`, `code`, `pluginName` and `details` properties.<br>`pluginName` contains the package name of the plugin that threw the error.<br>`details` contains a information about the error formatted in markdown. |
|
|
162
162
|
|
|
163
163
|
##### failComment examples
|
|
164
164
|
|
package/lib/get-fail-comment.js
CHANGED
|
@@ -7,9 +7,9 @@ const NEW_ISSUE_URL = `${HOME_URL}/issues/new`;
|
|
|
7
7
|
const formatError = error => `### ${error.message}
|
|
8
8
|
|
|
9
9
|
${error.details ||
|
|
10
|
-
`
|
|
10
|
+
`Unfortunately this error doesn't have any additional information.${
|
|
11
11
|
error.pluginName
|
|
12
|
-
? ` Feel free to kindly ask the author of the \`${error.pluginName}\` plugin to add more helpful
|
|
12
|
+
? ` Feel free to kindly ask the author of the \`${error.pluginName}\` plugin to add more helpful information.`
|
|
13
13
|
: ''
|
|
14
14
|
}`}`;
|
|
15
15
|
|
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": "5.4.
|
|
4
|
+
"version": "5.4.3",
|
|
5
5
|
"author": "Pierre Vanduynslager (https://twitter.com/@pvdlg_)",
|
|
6
6
|
"ava": {
|
|
7
7
|
"helpers": [
|
|
@@ -41,7 +41,7 @@
|
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"ava": "^2.0.0",
|
|
44
|
-
"clear-module": "^
|
|
44
|
+
"clear-module": "^4.0.0",
|
|
45
45
|
"codecov": "^3.5.0",
|
|
46
46
|
"commitizen": "^3.0.0",
|
|
47
47
|
"cz-conventional-changelog": "^2.0.0",
|