1 | const HOME_URL = 'https://github.com/semantic-release/semantic-release';
|
2 | const FAQ_URL = `${HOME_URL}/blob/caribou/docs/support/FAQ.md`;
|
3 | const GET_HELP_URL = `${HOME_URL}#get-help`;
|
4 | const USAGE_DOC_URL = `${HOME_URL}/blob/caribou/docs/usage/README.md`;
|
5 | const NEW_ISSUE_URL = `${HOME_URL}/issues/new`;
|
6 |
|
7 | const formatError = (error) => `### ${error.message}
|
8 |
|
9 | ${
|
10 | error.details ||
|
11 | `Unfortunately this error doesn't have any additional information.${
|
12 | error.pluginName
|
13 | ? ` Feel free to kindly ask the author of the \`${error.pluginName}\` plugin to add more helpful information.`
|
14 | : ''
|
15 | }`
|
16 | }`;
|
17 |
|
18 | module.exports = (branch, errors) => `## :rotating_light: The automated release from the \`${
|
19 | branch.name
|
20 | }\` branch failed. :rotating_light:
|
21 |
|
22 | I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.
|
23 |
|
24 | You can find below the list of errors reported by **semantic-release**. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.
|
25 |
|
26 | Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.
|
27 |
|
28 | Once all the errors are resolved, **semantic-release** will release your package the next time you push a commit to the \`${
|
29 | branch.name
|
30 | }\` branch. You can also manually restart the failed CI job that runs **semantic-release**.
|
31 |
|
32 | If you are not sure how to resolve this, here is some links that can help you:
|
33 | - [Usage documentation](${USAGE_DOC_URL})
|
34 | - [Frequently Asked Questions](${FAQ_URL})
|
35 | - [Support channels](${GET_HELP_URL})
|
36 |
|
37 | If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind **[semantic-release](${NEW_ISSUE_URL})**.
|
38 |
|
39 | ---
|
40 |
|
41 | ${errors.map((error) => formatError(error)).join('\n\n---\n\n')}
|
42 |
|
43 | ---
|
44 |
|
45 | Good luck with your project ✨
|
46 |
|
47 | Your **[semantic-release](${HOME_URL})** bot :package::rocket:`;
|