From a8ecc03c08e13fc274f657fd0ce3ec01a37385e6 Mon Sep 17 00:00:00 2001
From: Rhys Arkins <rhys@arkins.net>
Date: Tue, 13 Aug 2019 09:54:03 +0200
Subject: [PATCH] docs: improve platform-specific option descriptions
---
lib/config/definitions.js | 9 ++++-----
renovate-schema.json | 8 ++++----
2 files changed, 8 insertions(+), 9 deletions(-)
diff --git a/lib/config/definitions.js b/lib/config/definitions.js
index 804e13720e..8feaf32fdd 100644
--- a/lib/config/definitions.js
+++ b/lib/config/definitions.js
@@ -864,14 +864,13 @@ const options = [
},
{
name: 'rebaseStalePrs',
- description: 'Rebase stale PRs (GitHub only)',
+ description: 'Rebase any PRs that are not up-to-date with the base branch',
type: 'boolean',
default: null,
},
{
name: 'rebaseLabel',
- description:
- 'Label to use to request the bot to rebase a PR manually (GitHub only)',
+ description: 'Label to use to request the bot to rebase a PR manually',
type: 'string',
default: 'rebase',
},
@@ -1130,7 +1129,7 @@ const options = [
{
name: 'assignees',
description:
- 'Assignees for Pull Request (username in GitHub/GitLab, email address in Azure DevOps)',
+ 'Assignees for Pull Request (either username or email address depending on the platform)',
type: 'array',
subType: 'string',
},
@@ -1144,7 +1143,7 @@ const options = [
{
name: 'reviewers',
description:
- 'Requested reviewers for Pull Requests (username in GitHub/GitLab/Bitbucket, email or username in Azure DevOps)',
+ 'Requested reviewers for Pull Requests (either username or email address depending on the platform)',
type: 'array',
subType: 'string',
},
diff --git a/renovate-schema.json b/renovate-schema.json
index 9f17f6d6c4..b2391d8fc4 100644
--- a/renovate-schema.json
+++ b/renovate-schema.json
@@ -562,12 +562,12 @@
"default": false
},
"rebaseStalePrs": {
- "description": "Rebase stale PRs (GitHub only)",
+ "description": "Rebase any PRs that are not up-to-date with the base branch",
"type": "boolean",
"default": null
},
"rebaseLabel": {
- "description": "Label to use to request the bot to rebase a PR manually (GitHub only)",
+ "description": "Label to use to request the bot to rebase a PR manually",
"type": "string",
"default": "rebase"
},
@@ -756,7 +756,7 @@
}
},
"assignees": {
- "description": "Assignees for Pull Request (username in GitHub/GitLab, email address in Azure DevOps)",
+ "description": "Assignees for Pull Request (either username or email address depending on the platform)",
"type": "array",
"items": {
"type": "string"
@@ -768,7 +768,7 @@
"default": false
},
"reviewers": {
- "description": "Requested reviewers for Pull Requests (username in GitHub/GitLab/Bitbucket, email or username in Azure DevOps)",
+ "description": "Requested reviewers for Pull Requests (either username or email address depending on the platform)",
"type": "array",
"items": {
"type": "string"
--
GitLab