renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-11 14:36:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

docs: improve self-hosted documentation (#9315)

Browse source
This commit is contained in:
HonkingGoose 2021-04-01 13:19:57 +02:00 committed by GitHub
parent 8216fdd570
commit 0ca74bd2ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 0 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/usage/self-hosted-configuration.md
View file

@ -199,9 +199,6 @@ You probably have no need for this option - it is an experimental setting for th
You can customize the Git author that's used whenever Renovate creates a commit. You can customize the Git author that's used whenever Renovate creates a commit.
The `gitAuthor` option accepts a RFC5322-compliant string. The `gitAuthor` option accepts a RFC5322-compliant string.
If you are migrating from a old Git author to a new Git author, put the old `gitAuthor` into `RENOVATE_LEGACY_GIT_AUTHOR_EMAIL` in environment (TODO: Explain where/what is this "environment"???).
Renovate will then check for the old and current Git author before it decides if a branch has been modified.
**Note** We strongly recommend that the Git author email you use is unique to Renovate. **Note** We strongly recommend that the Git author email you use is unique to Renovate.
Otherwise, if another bot or human shares the same email and pushes to one of Renovate's branches then Renovate will mistake the branch as unmodified and potentially force push over the changes. Otherwise, if another bot or human shares the same email and pushes to one of Renovate's branches then Renovate will mistake the branch as unmodified and potentially force push over the changes.
@ -242,16 +239,12 @@ Warning: Configuring `logLevel` config option or `--log-level` cli option is dep
## onboarding ## onboarding
Set this to `false` if (a) you configure Renovate entirely on the bot side (i.e. empty `renovate.json` in repositories) and (b) you wish to run Renovate on every repository the bot has access to, and (c) you wish to skip the onboarding PRs.
Set this to `false` only if all three statements are true: Set this to `false` only if all three statements are true:
- You've configured Renovate entirely on the bot side (e.g. empty `renovate.json` in repositories) - You've configured Renovate entirely on the bot side (e.g. empty `renovate.json` in repositories)
- You want to run Renovate on every repository the bot has access to - You want to run Renovate on every repository the bot has access to
- You want to skip all onboarding PRs - You want to skip all onboarding PRs
TODO: check if the list should replace the (a,b,c) statements.
## onboardingBranch ## onboardingBranch
Note that this setting is independent of `branchPrefix`. Note that this setting is independent of `branchPrefix`.
@ -333,8 +326,6 @@ JSON files will be stored inside the `cacheDir` beside the existing file-based p
Warning: this is an experimental feature and may be modified or removed in a future non-major release. Warning: this is an experimental feature and may be modified or removed in a future non-major release.
TODO: Check if this feature is still present in Renovate code.
## requireConfig ## requireConfig
## secrets ## secrets