diff --git a/README.md b/README.md index 0b23017a8991f81fe18a700644e1b1fb28c8b15a..1392bcb1c8fdb251a46734ca3122f9d84432285a 100644 --- a/README.md +++ b/README.md @@ -35,5 +35,20 @@ configure the bot accordingly. Pay attention to the following: to `gitlab` in your configuration. * [GitLab platform integration](https://docs.renovatebot.com/modules/platform/gitlab/) requires that you declare a `RENOVATE_TOKEN` variable with an access token. -* You'll also probaly need to declare a `GITHUB_COM_TOKEN` variable, holding a GitHub access token +* You'll also probaly need to declare a `GITHUB_COM_TOKEN` variable, holding a GitHub access token (for [fetching changelogs](https://docs.renovatebot.com/getting-started/running/#githubcom-token-for-changelogs)) + +### Dry-run implementation details + +Depending on the source of a pipeline, the template will either perform your dependency updates (create/update/delete branches and MRs) +or [perform a dry run](https://docs.renovatebot.com/self-hosted-configuration/#dryrun) (to preview the behavior of Renovate with logs, without making any changes to your repositories). + +The real dependency updates is triggered only when: + +- the pipeline is started from the **web interface** (menu _Build > Pipelines_, click _Run pipeline_), +- or the pipeline is started from a **scheduled run** (menu _Build > Pipeline schedules_). + +In any other case (regular Git commit or else) the template will perform a dry run. + +:warning: Dry-run behavior is enabled/disabled with the `RENOVATE_DRY_RUN` environment variable. +Please don't try to override it or you might break the default template implementation.