From 4883e05bd8de6a026fc5fb420b8a03a7e2fbcc90 Mon Sep 17 00:00:00 2001 From: Elizabeth Craig Date: Thu, 18 Aug 2022 14:36:28 -0700 Subject: [PATCH] docs: add hr between configs in readme --- .gitignore | 2 ++ README.md | 30 ++++++++++++++++++++++++++++++ scripts/updateReadme.js | 2 ++ 3 files changed, 34 insertions(+) diff --git a/.gitignore b/.gitignore index 4407242a..1147d23e 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,5 @@ yarn-error.log* node_modules .cache .yarn + +NOTES.md diff --git a/README.md b/README.md index dd856a18..74086abd 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,8 @@ This config should be kept somewhat basic. It's somewhat similar to Renovate's [ - `vulnerabilityAlerts`: Enable PRs to address security vulnerabilities. Note that this **only** works for GitHub and currently is **only** able to update direct dependencies (except in repos using `npm` 6 or older). +--- + #### `libraryRecommended` Recommended config for a JS library repo or monorepo, including pinning `devDependencies`. @@ -168,6 +170,8 @@ Recommended config for a JS library repo or monorepo, including pinning `devDepe +--- + #### `beachballLibraryRecommended` Dependency management strategy for library repos, including Beachball change file generation. @@ -243,6 +247,8 @@ Note that in the GitHub app, commands in [`postUpgradeTasks`](https://docs.renov +--- + ### Grouping presets #### `groupMore` @@ -274,6 +280,8 @@ To use this preset but disable an individual grouping, add its name to the `igno +--- + #### `groupEslint` Group all eslint-related updates (except when initially pinning). @@ -298,6 +306,8 @@ Group all eslint-related updates (except when initially pinning). +--- + #### `groupFixtureUpdates` Group, schedule, and auto-merge all dependency updates in `__fixtures__` sub-folders. @@ -354,6 +364,8 @@ To customize this rule's behavior for individual packages, you can add entries t - Limit the allowed versions for a specific package: `{ "matchPackageNames": ["foo"], "allowedVersions": "<6.0.0 }` +--- + #### `groupFluent` Group Fluent UI and related package updates (except when initially pinning). @@ -433,6 +445,8 @@ If any packages are mis-categorized, please file an issue. +--- + #### `groupJest` Group jest, ts-jest, jest types, and related packages (except when initially pinning). @@ -458,6 +472,8 @@ This uses the same name as (and therefore extends) the built-in configs [`group: +--- + #### `groupReact` Group React packages and types (except when initially pinning). @@ -491,6 +507,8 @@ Unlike Renovate's React grouping preset, this version includes `@types` and (via +--- + #### `groupRollup` Group all rollup-related updates (except when initially pinning). @@ -516,6 +534,8 @@ Group all rollup-related updates (except when initially pinning). +--- + ### Other presets #### `automergeDevLock` @@ -554,6 +574,8 @@ Experimentally, this preset has `stabilityDays` set to 2 to reduce the chance of +--- + #### `automergeTypes` Auto-merge minor and patch updates to `@types` `devDependencies` (if the build passes). @@ -583,6 +605,8 @@ Any branch policies will be respected, including required status checks and requ +--- + #### `dependencyDashboardMajor` Require dependency dashboard approval for major upgrades (and minor upgrades of deps known not to follow semver). @@ -629,6 +653,8 @@ Some alternative strategies which would need to be configured per repo (see [Ren - Set [schedules](https://docs.renovatebot.com/configuration-options/#schedule) for individual `packageRules` groups to avoid the upgrades being forgotten. +--- + #### `keepFresh` Keep locally-used dependency versions deduplicated and updated. @@ -658,6 +684,8 @@ It's **highly recommended** to manually run the deduplication command before ena +--- + #### `newConfigWarningIssue` Always create a new issue if there's a config problem (for visibility). @@ -676,6 +704,8 @@ Always create a new issue if there's a config problem (for visibility). +--- + ## Contributing diff --git a/scripts/updateReadme.js b/scripts/updateReadme.js index 2193bc2a..d2f6bbf1 100644 --- a/scripts/updateReadme.js +++ b/scripts/updateReadme.js @@ -153,6 +153,8 @@ ${modifiedJson} ${comments.extra.start} ${extraContent} ${comments.extra.end} + +--- `, }; });