diff --git a/lib/config/options/index.ts b/lib/config/options/index.ts index f540e3fb88c7d545732366eca9236d3164522ab4..76f5d4a9ce5f0daaa058bc1f06d1d451d003c20e 100644 --- a/lib/config/options/index.ts +++ b/lib/config/options/index.ts @@ -71,7 +71,7 @@ const options: RenovateOptions[] = [ }, { name: 'format', - description: 'Format of the custom datasource', + description: 'Format of the custom datasource.', type: 'string', parent: 'customDatasources', default: 'json', @@ -345,7 +345,7 @@ const options: RenovateOptions[] = [ }, { name: 'customDatasources', - description: 'Defines custom datasources for usage by managers', + description: 'Defines custom datasources for usage by managers.', type: 'object', experimental: true, experimentalIssues: [23286], @@ -391,7 +391,7 @@ const options: RenovateOptions[] = [ }, { name: 'goGetDirs', - description: 'Directory pattern to run `go get` on', + description: 'Directory pattern to run `go get` on.', type: 'array', subType: 'string', default: ['./...'], @@ -622,7 +622,7 @@ const options: RenovateOptions[] = [ { name: 'timezone', description: - '[IANA Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)', + 'Must conform to [IANA Time Zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) format.', type: 'string', }, { @@ -963,7 +963,7 @@ const options: RenovateOptions[] = [ { name: 'defaultRegistryUrlTemplate', description: - 'Template for generating a defaultRegistryUrl for custom datasource', + 'Template for generating a `defaultRegistryUrl` for custom datasource.', type: 'string', default: '', parent: 'customDatasources', @@ -1289,7 +1289,7 @@ const options: RenovateOptions[] = [ { name: 'matchCurrentVersion', description: - 'A version or range of versions to match against the current version of a package. Valid only within a `packageRules` object.', + 'A version, or range of versions, to match against the current version of a package. Valid only within a `packageRules` object.', type: 'string', stage: 'package', parent: 'packageRules', @@ -1823,7 +1823,7 @@ const options: RenovateOptions[] = [ }, { name: 'transformTemplates', - description: 'List of jsonata transformation rules', + description: 'List of jsonata transformation rules.', type: 'array', subType: 'string', parent: 'customDatasources', @@ -1998,7 +1998,7 @@ const options: RenovateOptions[] = [ }, { name: 'customizeDashboard', - description: 'Customize sections in the dependency dashboard issue.', + description: 'Customize sections in the Dependency Dashboard issue.', type: 'object', default: {}, additionalProperties: { @@ -2357,7 +2357,7 @@ const options: RenovateOptions[] = [ { name: 'artifactAuth', description: - 'A list of package managers to enable artifact auth. Only managers on the list are enabled. All are enabled if `null`', + 'A list of package managers to enable artifact auth. Only managers on the list are enabled. All are enabled if `null`.', experimental: true, type: 'array', subType: 'string', @@ -2409,7 +2409,7 @@ const options: RenovateOptions[] = [ }, { name: 'cacheTtlOverride', - description: 'An object that contains cache namespace TTL override values', + description: 'An object that contains cache namespace TTL override values.', type: 'object', stage: 'repository', default: {}, diff --git a/lib/config/presets/internal/security.ts b/lib/config/presets/internal/security.ts index f986db04d204249c54256ef1ceae963ca702620c..6c19f6aaa62cb55fcf561d6c5958cdd5a80d79a8 100644 --- a/lib/config/presets/internal/security.ts +++ b/lib/config/presets/internal/security.ts @@ -2,7 +2,7 @@ import type { Preset } from '../types'; export const presets: Record<string, Preset> = { 'openssf-scorecard': { - description: 'Show OpenSSF badge on pull requests', + description: 'Show OpenSSF badge on pull requests.', packageRules: [ { matchSourceUrlPrefixes: ['https://github.com/'], diff --git a/lib/config/presets/internal/workarounds.ts b/lib/config/presets/internal/workarounds.ts index cd21e799aa60b8096ae8ea4e4f777c1438049146..ba7e304d808fcbe25412ad40ce23d1097ac45faf 100644 --- a/lib/config/presets/internal/workarounds.ts +++ b/lib/config/presets/internal/workarounds.ts @@ -24,7 +24,7 @@ export const presets: Record<string, Preset> = { ignoreDeps: [], // Hack to improve onboarding PR description }, containerbase: { - description: 'Add some containerbase overrides', + description: 'Add some containerbase overrides.', packageRules: [ { description: