From 4eb2230e7ebd21ecdc5f3c9412cd3c6b29e1df09 Mon Sep 17 00:00:00 2001 From: Jonas Schubert Date: Fri, 27 May 2022 14:07:41 +0200 Subject: [PATCH 1/2] docs(labels): add description and link for labels as well as an example #372 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38830f9d..c8b7026e 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ If you need to bypass the proxy for some hosts, configure the `NO_PROXY` environ | `successComment` | The comment to add to each Issue and Merge Request resolved by the release. Set to false to disable commenting. See [successComment](#successComment). | :tada: This issue has been resolved in version ${nextRelease.version} :tada:\n\nThe release is available on [GitLab release]() | | `failComment` | The content of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails. See [failComment](#failcomment). | Friendly message with links to **semantic-release** documentation and support, with the list of errors that caused the release to fail. | | `failTitle` | The title of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails. | `The automated release is failing 🚨` | -| `labels` | The [labels](https://docs.gitlab.com/ee/user/project/labels.html#labels) to add to the issue created when a release fails. Set to `false` to not add any label. | `semantic-release` | +| `labels` | The [labels](https://docs.gitlab.com/ee/user/project/labels.html#labels) to add to the issue created when a release fails. Set to `false` to not add any label. Labels should be a comma-separated as describe in the [officical docs](https://docs.gitlab.com/ee/api/issues.html#new-issue). E.g. `"semantic-release,bot"`. | `semantic-release` | | `assignee` | The [assignee](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#assignee) to add to the issue created when a release fails. | - | #### assets From 5cea206b19db5a3020be3d91d27f244624f6447b Mon Sep 17 00:00:00 2001 From: Florian Greinacher Date: Mon, 30 May 2022 16:40:21 +0200 Subject: [PATCH 2/2] docs: typo fixes --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c8b7026e..22e22caa 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ If you need to bypass the proxy for some hosts, configure the `NO_PROXY` environ | `successComment` | The comment to add to each Issue and Merge Request resolved by the release. Set to false to disable commenting. See [successComment](#successComment). | :tada: This issue has been resolved in version ${nextRelease.version} :tada:\n\nThe release is available on [GitLab release]() | | `failComment` | The content of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails. See [failComment](#failcomment). | Friendly message with links to **semantic-release** documentation and support, with the list of errors that caused the release to fail. | | `failTitle` | The title of the issue created when a release fails. Set to `false` to disable opening an issue when a release fails. | `The automated release is failing 🚨` | -| `labels` | The [labels](https://docs.gitlab.com/ee/user/project/labels.html#labels) to add to the issue created when a release fails. Set to `false` to not add any label. Labels should be a comma-separated as describe in the [officical docs](https://docs.gitlab.com/ee/api/issues.html#new-issue). E.g. `"semantic-release,bot"`. | `semantic-release` | +| `labels` | The [labels](https://docs.gitlab.com/ee/user/project/labels.html#labels) to add to the issue created when a release fails. Set to `false` to not add any label. Labels should be comma-separated as described in the [official docs](https://docs.gitlab.com/ee/api/issues.html#new-issue), e.g. `"semantic-release,bot"`. | `semantic-release` | | `assignee` | The [assignee](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#assignee) to add to the issue created when a release fails. | - | #### assets