From d9eab5ceef4d1dbd1fe41eca5b7d1e99feac5157 Mon Sep 17 00:00:00 2001 From: Rhys Arkins <rhys@arkins.net> Date: Sat, 16 Jun 2018 09:53:57 +0200 Subject: [PATCH] docs: fix onboarding PR description --- website/docs/configure-renovate.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/website/docs/configure-renovate.md b/website/docs/configure-renovate.md index d67d09c094..354fcf13a0 100644 --- a/website/docs/configure-renovate.md +++ b/website/docs/configure-renovate.md @@ -11,7 +11,7 @@ Once you have enabled Renovate on a repository, you will receive a "Configure Re ## No Risk Onboarding -Conveniently, Renovate will not make any changes to your repository or raise any further Pull Requests until after you _close or merge_ this initial Pull Request. So if there is anything about the Pull Request that you don't like or understand, take your time to read [documentation](/docs/) or ask questions in one of our support forums and merge the PR only once you're satisfied with the result. You can edit your Renovate configuration **within this `renovate/configure` branch** and Renovate will keep updating the description in the PR to match, so you can keep doing that until you're satisfied with the results. +Conveniently, Renovate will not make any changes to your repository or raise any further Pull Requests until after you _merge_ this initial Pull Request. So if there is anything about the Pull Request that you don't like or understand, take your time to read [documentation](/docs/) or ask questions in one of our support forums and merge the PR only once you're satisfied with the result. You can edit your Renovate configuration **within this `renovate/configure` branch** and Renovate will keep updating the description in the PR to match, so you can keep doing that until you're satisfied with the results. ## Check for Warnings @@ -21,9 +21,7 @@ If you have any Warnings or Errors listed, see if you need or want to make any c The Configure Renovate PR will include a `renovate.json` file in the root directory, with suggested default settings. -It's not mandatory to have a `renovate.json` in your repository but strongly recommended. If Renovate's default settings work well for you then you can simply close this PR unmerged to run Renovate without _any_ override configuration. However it's recommended that you try deleting the `renovate.json` from the `renovate/configure` branch first to check that the results are as you wish. - -If you want to override some of Renovate's default settings but not have a `renovate.json`, then you can instead add the same settings to a `"renovate"` section in your `package.json`. Note though that if you run a monorepo with more than one `package.json` file then you may need to add the same configuration to all of them. Again, please make these changes within the `renovate/configure` branch of this PR to make sure that the results match your expectations. +If you don't want to have an additional file (`renovate.json`) in your repository then you can instead add the same settings to a `"renovate"` section in your `package.json`, if you are already using this (e.g. javascript project). Any settings made in `package.json` will apply to the whole project (including other, nested `package.json` files). Alternatively, if you prefer to use "dot files" then you can add the same JSON configuration to either a `.renovaterc` file or `.renovaterc.json` file instead of `renovate.json`. @@ -32,13 +30,13 @@ Alternatively, if you prefer to use "dot files" then you can add the same JSON c Most of the settings in the `renovate.json` onboarding configuration are defaults, however usually this configuration file will have some default overrides in it, such as: - Automatically enabling angular-style semantic commits if your repository uses them -- Setting `pinVersions` to false for `dependencies` unless your `package.json` file are all `private` +- Determining whether to use dependency range pinning depending on the detected project type ## Common Overrides Please check the docs on this website for an exhaustive Configuration Reference, however here are some of the most commonly changed (overridden) configuration settings: -- **pinVersions**: By default (with zero config) it's `false` however the `"config:base"` preset overrides it to autodetect. +- **rangeStrategy**: By default (with zero config) it's `"replace"` however the `"config:base"` preset overrides it to `"auto"`. If you don't want to pin dependency versions and retain ranges, add the `":preserveSemverRanges"` preset to the `extends` array. - **labels**: Labels to assign to Pull Requests - **assignees**: GitHub users to assign the Pull Requests to -- GitLab