|
23 | 23 | }
|
24 | 24 | },
|
25 | 25 | "allowCustomCrateRegistries": {
|
26 |
| - "description": "Set this to `true` if custom crate registries are allowed.", |
| 26 | + "description": "Set this to `true` to allow custom crate registries.", |
27 | 27 | "type": "boolean",
|
28 | 28 | "default": false
|
29 | 29 | },
|
|
107 | 107 | "default": false
|
108 | 108 | },
|
109 | 109 | "assigneesSampleSize": {
|
110 |
| - "description": "Take a random sample of given size from assignees.", |
| 110 | + "description": "Take a random sample of given size from `assignees`.", |
111 | 111 | "type": "integer",
|
112 | 112 | "default": null
|
113 | 113 | },
|
|
192 | 192 | "$ref": "#"
|
193 | 193 | },
|
194 | 194 | "azureAutoApprove": {
|
195 |
| - "description": "If set to `true`, Azure DevOps PRs will be automatically approved.", |
| 195 | + "description": "Set to `true` to automatically approve Azure DevOps PRs.", |
196 | 196 | "type": "boolean",
|
197 | 197 | "default": false
|
198 | 198 | },
|
|
299 | 299 | "default": "renovate/"
|
300 | 300 | },
|
301 | 301 | "branchPrefixOld": {
|
302 |
| - "description": "Old Prefix to check for existing PRs.", |
| 302 | + "description": "Old branchPrefix value to check for existing PRs.", |
303 | 303 | "type": "string",
|
304 | 304 | "default": "renovate/"
|
305 | 305 | },
|
|
389 | 389 | "$ref": "#"
|
390 | 390 | },
|
391 | 391 | "cloneSubmodules": {
|
392 |
| - "description": "Set to `true` to enable initialization of submodules during repository clone.", |
| 392 | + "description": "Set to `true` to initialize submodules during repository clone.", |
393 | 393 | "type": "boolean",
|
394 | 394 | "default": false
|
395 | 395 | },
|
|
556 | 556 | "default": null
|
557 | 557 | },
|
558 | 558 | "dependencyDashboardTitle": {
|
559 |
| - "description": "Title to use for the Dependency Dashboard issue.", |
| 559 | + "description": "Title for the Dependency Dashboard issue.", |
560 | 560 | "type": "string",
|
561 | 561 | "default": "Dependency Dashboard"
|
562 | 562 | },
|
|
586 | 586 | ]
|
587 | 587 | },
|
588 | 588 | "detectGlobalManagerConfig": {
|
589 |
| - "description": "If `true`, Renovate will try to detect global manager configuration from the file system.", |
| 589 | + "description": "If `true`, Renovate tries to detect global manager configuration from the file system.", |
590 | 590 | "type": "boolean",
|
591 | 591 | "default": false
|
592 | 592 | },
|
593 | 593 | "detectHostRulesFromEnv": {
|
594 |
| - "description": "If `true`, Renovate will try to detect host rules from environment variables.", |
| 594 | + "description": "If `true`, Renovate tries to detect host rules from environment variables.", |
595 | 595 | "type": "boolean",
|
596 | 596 | "default": false
|
597 | 597 | },
|
|
684 | 684 | "type": "boolean"
|
685 | 685 | },
|
686 | 686 | "enabledManagers": {
|
687 |
| - "description": "A list of package managers to enable. If defined, then all managers not on the list are disabled.", |
| 687 | + "description": "A list of package managers to enable. Only managers on the list are enabled.", |
688 | 688 | "type": "array"
|
689 | 689 | },
|
690 | 690 | "encrypted": {
|
|
699 | 699 | "default": null
|
700 | 700 | },
|
701 | 701 | "excludeCommitPaths": {
|
702 |
| - "description": "A file that matches any of these glob patterns will not be committed, even if it has been updated.", |
| 702 | + "description": "A file matching any of these glob patterns will not be committed, even if the file has been updated.", |
703 | 703 | "type": "array",
|
704 | 704 | "items": {
|
705 | 705 | "type": "string"
|
|
987 | 987 | "default": null
|
988 | 988 | },
|
989 | 989 | "groupSlug": {
|
990 |
| - "description": "Slug to use for group (e.g. in branch name). Will be calculated from `groupName` if `null`.", |
| 990 | + "description": "Slug to use for group (e.g. in branch name). Slug is calculated from `groupName` if `null`.", |
991 | 991 | "type": "string",
|
992 | 992 | "default": null
|
993 | 993 | },
|
|
1099 | 1099 | }
|
1100 | 1100 | },
|
1101 | 1101 | "abortOnError": {
|
1102 |
| - "description": "If enabled, Renovate will abort its run when HTTP request errors occur.", |
| 1102 | + "description": "If enabled, Renovate aborts its run when HTTP request errors occur.", |
1103 | 1103 | "type": "boolean",
|
1104 | 1104 | "default": false
|
1105 | 1105 | },
|
|
1565 | 1565 | "default": "Configure Renovate"
|
1566 | 1566 | },
|
1567 | 1567 | "optimizeForDisabled": {
|
1568 |
| - "description": "Set to `true` to first check for disabling in config before cloning.", |
| 1568 | + "description": "Set to `true` to perform a check for disabled config prior to cloning.", |
1569 | 1569 | "type": "boolean",
|
1570 | 1570 | "default": false
|
1571 | 1571 | },
|
|
1644 | 1644 | ]
|
1645 | 1645 | },
|
1646 | 1646 | "matchCurrentValue": {
|
1647 |
| - "description": "A regex to match against the raw currentValue string of a dependency. Valid only within a `packageRules` object.", |
| 1647 | + "description": "A regex to match against the raw `currentValue` string of a dependency. Valid only within a `packageRules` object.", |
1648 | 1648 | "type": "string"
|
1649 | 1649 | },
|
1650 | 1650 | "matchCurrentVersion": {
|
|
1680 | 1680 | ]
|
1681 | 1681 | },
|
1682 | 1682 | "matchFiles": {
|
1683 |
| - "description": "List of strings to do an exact match against package files with full path. Will only work inside a `packageRules` object.", |
| 1683 | + "description": "List of strings to do an exact match against package files with full path. Only works inside a `packageRules` object.", |
1684 | 1684 | "type": "array",
|
1685 | 1685 | "items": {
|
1686 | 1686 | "type": "string"
|
|
1759 | 1759 | ]
|
1760 | 1760 | },
|
1761 | 1761 | "matchPaths": {
|
1762 |
| - "description": "List of strings or glob patterns to match against package files. Will only work inside a `packageRules` object.", |
| 1762 | + "description": "List of strings or glob patterns to match against package files. Only works inside a `packageRules` object.", |
1763 | 1763 | "type": "array",
|
1764 | 1764 | "items": {
|
1765 | 1765 | "type": "string"
|
|
1853 | 1853 | "$ref": "#"
|
1854 | 1854 | },
|
1855 | 1855 | "persistRepoData": {
|
1856 |
| - "description": "If set to `true`, repository data is kept between runs instead of deleted.", |
| 1856 | + "description": "If set to `true`: keep repository data between runs instead of deleting the data.", |
1857 | 1857 | "type": "boolean",
|
1858 | 1858 | "default": false
|
1859 | 1859 | },
|
|
2038 | 2038 | ]
|
2039 | 2039 | },
|
2040 | 2040 | "prBodyDefinitions": {
|
2041 |
| - "description": "Table column definitions for use in PR tables.", |
| 2041 | + "description": "Table column definitions to use in PR tables.", |
2042 | 2042 | "type": "object",
|
2043 | 2043 | "default": {
|
2044 | 2044 | "Package": "{{{depNameLinked}}}",
|
|
2053 | 2053 | }
|
2054 | 2054 | },
|
2055 | 2055 | "prBodyNotes": {
|
2056 |
| - "description": "List of additional notes/templates to be included in the Pull Request bodies.", |
| 2056 | + "description": "List of additional notes/templates to include in the Pull Request body.", |
2057 | 2057 | "oneOf": [
|
2058 | 2058 | {
|
2059 | 2059 | "type": "array",
|
|
2138 | 2138 | "$ref": "#"
|
2139 | 2139 | },
|
2140 | 2140 | "printConfig": {
|
2141 |
| - "description": "If enabled, Renovate logs the fully resolved config for each repo, plus the fully resolved presets.", |
| 2141 | + "description": "If enabled, Renovate logs the fully resolved config for each repository, plus the fully resolved presets.", |
2142 | 2142 | "type": "boolean",
|
2143 | 2143 | "default": false
|
2144 | 2144 | },
|
|
2381 | 2381 | "default": "disabled"
|
2382 | 2382 | },
|
2383 | 2383 | "repositoryCacheType": {
|
2384 |
| - "description": "Set the type of renovate repository cache if repositoryCache is not disabled.", |
| 2384 | + "description": "Set the type of renovate repository cache if `repositoryCache` is enabled.", |
2385 | 2385 | "type": "string",
|
2386 | 2386 | "default": "local"
|
2387 | 2387 | },
|
|
2412 | 2412 | "default": false
|
2413 | 2413 | },
|
2414 | 2414 | "reviewersSampleSize": {
|
2415 |
| - "description": "Take a random sample of given size from reviewers.", |
| 2415 | + "description": "Take a random sample of given size from `reviewers`.", |
2416 | 2416 | "type": "integer",
|
2417 | 2417 | "default": null
|
2418 | 2418 | },
|
|
0 commit comments