Skip to content

Commit

Permalink
docs: improve descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
rarkins committed Nov 5, 2021
1 parent 2735ac3 commit 4eadba6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
14 changes: 8 additions & 6 deletions docs/usage/configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -763,8 +763,8 @@ Configuration added here applies for all Go-related updates, however currently t

For self-hosted users, `GOPROXY`, `GONOPROXY` and `GOPRIVATE` environment variables are supported ([reference](https://golang.org/ref/mod#module-proxy)).

Usage of `direct` will fallback to Renovate-native release fetching mechanism.
Also we support `off` keyword which immediately will stop any fetching.
Usage of `direct` will fallback to the Renovate-native release fetching mechanism.
Also we support the `off` keyword which will stop any fetching immediately.

## group

Expand Down Expand Up @@ -1668,7 +1668,7 @@ If enabled Renovate will pin Docker images by means of their SHA256 digest and n

## platformAutomerge

If you have enabled `automerge` and set `automergeType=pr` in the Renovate config, then you can also set `platformAutomerge` to true to speed up merging via the platform's native automerge functionality.
If you have enabled `automerge` and set `automergeType=pr` in the Renovate config, then you can also set `platformAutomerge` to `true` to speed up merging via the platform's native automerge functionality.

Renovate tries platform-native automerge only when it initially creates the PR.
Any PR that is being updated will be automerged with the Renovate-based automerge.
Expand All @@ -1677,10 +1677,12 @@ Any PR that is being updated will be automerged with the Renovate-based automerg
This option is available for Azure, GitHub and GitLab.
It falls back to Renovate-based automerge if the platform-native automerge is not available.

You can also fine tune the behavior by setting `packageRules` if you want to use it selectively (e.g. per-package).
You can also fine-tune the behavior by setting `packageRules` if you want to use it selectively (e.g. per-package).

If you rely on Renovate's behavior of rebasing automerging branches when `rebaseWhen=auto`, then note that you are no longer guaranteed of up-to-date branches when automerging if you enable platform automerge, unless you use some type of branch protection rules to achieve the same.
For example, GitHub might automerge a Renovate branch even if it is one or more commits behind the base branch at the time.
Note that the outcome of `rebaseWhen=auto` can differ when `platformAutomerge=true`.
Normally when you set `rebaseWhen=auto` Renovate rebases any branch that's behind the base branch automatically, and some people rely on that.
This behavior is no longer guaranteed when you enable `platformAutomerge` because the platform might automerge a branch which is not up-to-date.
For example, GitHub might automerge a Renovate branch even if it's behind the base branch at the time.

## postUpdateOptions

Expand Down
2 changes: 1 addition & 1 deletion lib/manager/regex/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ function handleRecursive(
return [];
}
return regexMatchAll(regexes[index], content).flatMap((match) => {
// if we have a depName and a currentValue with have the minimal viable definition
// if we have a depName and a currentValue which have the minimal viable definition
if (match?.groups?.depName && match?.groups?.currentValue) {
return createDependency(
{
Expand Down

0 comments on commit 4eadba6

Please sign in to comment.