Skip to content

Commit

Permalink
fix: typos in fail messages (#205)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ithildir authored and gr2m committed Jul 19, 2019
1 parent 9ea29dd commit 7e66a99
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
| `verifyConditions` | Verify the presence and the validity of the authentication (set via [environment variables](#environment-variables)) and the [assets](#assets) option configuration. |
| `publish` | Publish a [GitHub release](https://help.github.com/articles/about-releases), optionally uploading file assets. |
| `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. |
| `fail` | Open or update a [GitHub Issue](https://help.github.com/articles/about-issues) with informations about the errors that caused the release to fail. |
| `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. |

## Install

Expand Down Expand Up @@ -158,7 +158,7 @@ The message for the issue content is generated with [Lodash template](https://lo
| Parameter | Description |
|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `branch` | The branch from which the release had failed. |
| `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 informations about the error formatted in markdown. |
| `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. |

##### failComment examples

Expand Down
4 changes: 2 additions & 2 deletions lib/get-fail-comment.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ const NEW_ISSUE_URL = `${HOME_URL}/issues/new`;
const formatError = error => `### ${error.message}
${error.details ||
`Unfortunatly this error doesn't have any additionnal information.${
`Unfortunately this error doesn't have any additional information.${
error.pluginName
? ` Feel free to kindly ask the author of the \`${error.pluginName}\` plugin to add more helpful informations.`
? ` Feel free to kindly ask the author of the \`${error.pluginName}\` plugin to add more helpful information.`
: ''
}`}`;

Expand Down
4 changes: 2 additions & 2 deletions test/get-fail-comment.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ test('Comment with missing error details and pluginName', t => {
t.regex(comment, /the `master` branch/);
t.regex(
comment,
/---\n\n### Error message 1\n\nUnfortunatly this error doesn't have any additionnal information. Feel free to kindly ask the author of the `some-plugin` plugin to add more helpful informations.\n\n---/
/---\n\n### Error message 1\n\nUnfortunately this error doesn't have any additional information. Feel free to kindly ask the author of the `some-plugin` plugin to add more helpful information.\n\n---/
);
});

Expand All @@ -46,6 +46,6 @@ test('Comment with missing error details and no pluginName', t => {
t.regex(comment, /the `master` branch/);
t.regex(
comment,
/---\n\n### Error message 1\n\nUnfortunatly this error doesn't have any additionnal information.\n\n---/
/---\n\n### Error message 1\n\nUnfortunately this error doesn't have any additional information.\n\n---/
);
});

0 comments on commit 7e66a99

Please sign in to comment.