Skip to content

Commit

Permalink
docs: add hr between configs in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ecraig12345 committed Aug 18, 2022
1 parent c50b1bc commit 4883e05
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ yarn-error.log*
node_modules
.cache
.yarn

NOTES.md
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
<!-- end extra content -->

---

#### `libraryRecommended`

Recommended config for a JS library repo or monorepo, including pinning `devDependencies`.
Expand Down Expand Up @@ -168,6 +170,8 @@ Recommended config for a JS library repo or monorepo, including pinning `devDepe

<!-- end extra content -->

---

#### `beachballLibraryRecommended`

Dependency management strategy for library repos, including Beachball change file generation.
Expand Down Expand Up @@ -243,6 +247,8 @@ Note that in the GitHub app, commands in [`postUpgradeTasks`](https://docs.renov

<!-- end extra content -->

---

### Grouping presets

#### `groupMore`
Expand Down Expand Up @@ -274,6 +280,8 @@ To use this preset but disable an individual grouping, add its name to the `igno

<!-- end extra content -->

---

#### `groupEslint`

Group all eslint-related updates (except when initially pinning).
Expand All @@ -298,6 +306,8 @@ Group all eslint-related updates (except when initially pinning).

<!-- end extra content -->

---

#### `groupFixtureUpdates`

Group, schedule, and auto-merge all dependency updates in `__fixtures__` sub-folders.
Expand Down Expand Up @@ -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 }`
<!-- end extra content -->

---

#### `groupFluent`

Group Fluent UI and related package updates (except when initially pinning).
Expand Down Expand Up @@ -433,6 +445,8 @@ If any packages are mis-categorized, please file an issue.

<!-- end extra content -->

---

#### `groupJest`

Group jest, ts-jest, jest types, and related packages (except when initially pinning).
Expand All @@ -458,6 +472,8 @@ This uses the same name as (and therefore extends) the built-in configs [`group:

<!-- end extra content -->

---

#### `groupReact`

Group React packages and types (except when initially pinning).
Expand Down Expand Up @@ -491,6 +507,8 @@ Unlike Renovate's React grouping preset, this version includes `@types` and (via

<!-- end extra content -->

---

#### `groupRollup`

Group all rollup-related updates (except when initially pinning).
Expand All @@ -516,6 +534,8 @@ Group all rollup-related updates (except when initially pinning).

<!-- end extra content -->

---

### Other presets

#### `automergeDevLock`
Expand Down Expand Up @@ -554,6 +574,8 @@ Experimentally, this preset has `stabilityDays` set to 2 to reduce the chance of

<!-- end extra content -->

---

#### `automergeTypes`

Auto-merge minor and patch updates to `@types` `devDependencies` (if the build passes).
Expand Down Expand Up @@ -583,6 +605,8 @@ Any branch policies will be respected, including required status checks and requ

<!-- end extra content -->

---

#### `dependencyDashboardMajor`

Require dependency dashboard approval for major upgrades (and minor upgrades of deps known not to follow semver).
Expand Down Expand Up @@ -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.
<!-- end extra content -->

---

#### `keepFresh`

Keep locally-used dependency versions deduplicated and updated.
Expand Down Expand Up @@ -658,6 +684,8 @@ It's **highly recommended** to manually run the deduplication command before ena

<!-- end extra content -->

---

#### `newConfigWarningIssue`

Always create a new issue if there's a config problem (for visibility).
Expand All @@ -676,6 +704,8 @@ Always create a new issue if there's a config problem (for visibility).

<!-- end extra content -->

---

<!-- end presets -->

## Contributing
Expand Down
2 changes: 2 additions & 0 deletions scripts/updateReadme.js
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,8 @@ ${modifiedJson}
${comments.extra.start}
${extraContent}
${comments.extra.end}
---
`,
};
});
Expand Down

0 comments on commit 4883e05

Please sign in to comment.