From bf2f9db59d87f0b07290d4f35ce169c3eb494328 Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Wed, 10 May 2023 11:28:57 +0200 Subject: [PATCH] docs: rewrite local platform (#22067) --- lib/modules/platform/local/index.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/lib/modules/platform/local/index.md b/lib/modules/platform/local/index.md index 7edadcb277..15ede0932e 100644 --- a/lib/modules/platform/local/index.md +++ b/lib/modules/platform/local/index.md @@ -1,20 +1,22 @@ # Local -The "local" platform exists to allow users to perform dry runs against the local file system, such as to test out new config. +With the "local" platform you can perform dry runs of Renovate against the local file system. +This can be handy when testing a new Renovate configuration for example. ## Usage -Run `renovate --platform=local` in the directory you want Renovate to run in. -In this mode, Renovate will default to `dryRun=lookup`. -No "repositories" arguments should be provided, as you cannot run against multiple directories or run in the non-working directory. +Run the `renovate --platform=local` command in the directory you want Renovate to run in. +In this mode, Renovate defaults to `dryRun=lookup`. -It is possible to run on both a git and non-git directory. -Config is optional - so it will run either with or without any "repo config" found. +Avoid giving "repositories" arguments, as this command can only run in a _single_ directory, and it can only run in the _current working_ directory. -It does not do any "compare" or before and after analysis - if your purpose is to test a new config then you will need to manually compare. +You may run the command above on "plain" directories, or "Git directories". +You don't need to provide any config, as the command will run with or without "repo config". + +The command doesn't do any "compare" - or before and after analysis - if you want to test a new config then you must manually compare. ## Limitations -- `local>` presets cannot be resolved. Normally these would point to the local platform such as GitHub, but in the case of running locally, it does not exist +- `local>` presets can't be resolved. Normally these would point to the local platform such as GitHub, but in the case of running locally, it does not exist - `baseBranches` are ignored - Branch creation is not supported -- GitLab