Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: improve descriptions #24946

Merged
merged 2 commits into from
Oct 2, 2023
Merged

chore: improve descriptions #24946

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69eb4a9
chore: improve descriptions
HonkingGoose Oct 2, 2023
cfaaace
Merge branch 'main' into chore/improve-descriptions
HonkingGoose Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 10 additions & 10 deletions lib/config/options/index.ts
View file
Open in desktop
Expand Up @@ -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',
Expand Down Expand Up @@ -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],
Expand Down Expand Up @@ -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: ['./...'],
Expand Down Expand Up @@ -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',
},
{
Expand Down Expand Up @@ -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',
Expand Down Expand Up @@ -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',
Expand Down Expand Up @@ -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',
Expand Down Expand Up @@ -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: {
Expand Down Expand Up @@ -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',
Expand Down Expand Up @@ -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: {},
Expand Down
2 changes: 1 addition & 1 deletion lib/config/presets/internal/security.ts
View file
Open in desktop
Expand Up @@ -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/'],
Expand Down
2 changes: 1 addition & 1 deletion lib/config/presets/internal/workarounds.ts
View file
Open in desktop
Expand Up @@ -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:
Expand Down