Commit 47c750cd authored by Michael Kriese's avatar Michael Kriese Committed by Rhys Arkins
Browse files

docs: update readme

parent d020809e
Loading
Loading
Loading
Loading
+18 −14
Original line number Diff line number Diff line
@@ -42,27 +42,29 @@ Create a `.gitlab-ci.yml` file in the repository like the following:
include:
  - project: 'renovate-bot/renovate-runner'
    file: '/templates/renovate-dind.gitlab-ci.yml'
```

variables:
  LOG_LEVEL: debug

stages:
  - deploy
Alternatively, if you cannot use the gitlab.com hosted or self-hosted privileged runners, include the following template instead:

renovate:
  stage: deploy
  only:
    - schedules
  script:
    - renovate $RENOVATE_EXTRA_FLAGS
```yaml
include:
  - project: 'renovate-bot/renovate-runner'
    file: '/templates/renovate.gitlab-ci.yml'
```

Alternatively, if you cannot use privileged runners, include the following template instead:
By default our pipeline only runs on schedules.
If you want it to run on other events checkout [here](https://docs.gitlab.com/ee/ci/yaml/README.html#onlyexcept-basic).

Example for run on schedules and pushes:
```yaml
include:
  - project: 'renovate-bot/renovate-runner'
    file: '/templates/renovate.gitlab-ci.yml'
    file: '/templates/renovate-dind.gitlab-ci.yml'

renovate:
  only:
    - schedules
    - pushes
``` 

## Configure the Schedule
@@ -72,6 +74,8 @@ Best practise it to run it hourly.

The following sample run it every hour on third minute: `3 * * * *`.

Because the default pipeline only runs on schedules, you need to use the `play` button of schedule to trigger a manual run.

## Other config options

We've changed some renovate defaults for GitLab to better reflect the App's default behavior, so please see [here](./templates/_common.gitlab-ci.yml#L1) for changed options.