@@ -4,19 +4,19 @@ The intention of this project is to provide a pipeline which is easy to set up a
You will need to:
1. Create a new private project to host the runner
1. Create a new project to host the runner
2. Configure credentials using CI variables
3. Create a new `master` pipeline that includes this project's template
4. Set up a schedule to run the pipeline regularly
## Create a new runner Project
We recommend you use a dedicated private project to host the Renovate runner.
Easiest is to start with a new empty project.
We recommend you use a new and dedicated private project to host the Renovate runner, however a public project with private CI logs should still be safe.
Currently one advantage of public projecs is that CI minutes are not restricted however the same restrictions as private projects will soon apply.
## Configure CI/CD variables
At a minimum you need to add a GitLab [Personal Access Token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token)(scopes:`read_user`, `api` and `write_repository`) as `RENOVATE_TOKEN` to CI/CD variables.
You need to add a GitLab [Personal Access Token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#creating-a-personal-access-token)(scopes:`read_user`, `api` and `write_repository`) as `RENOVATE_TOKEN` to CI/CD variables.
It is also recommended to configure a [GitHub.com Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token)(minimum scopes) as `GITHUB_COM_TOKEN` so that your bot can make authenticated requests to github.com for Changelog retrieval as well as for any dependency that uses GitHub tags.
Without such a token, github.com's API will rate limit requests and make such lookups unreliable.
@@ -26,9 +26,13 @@ The default settings will run against any projects which satisfies these two cha
- The bot's token has Developer or higher access rights
- The project has a Renovate configuration file already (e.g. `renovate.json`)
If you wish for your bot to run against *every* project which it has access to, including onboarding any which don't yet have a config, then add this variable: `RENOVATE_EXTRA_FLAGS="--onboarding=true"`.
If you wish for your bot to run against *every* project which the `RENOVATE_TOKEN` PAT has access to, including onboarding any projects which don't yet have a config, then add this variable: `RENOVATE_EXTRA_FLAGS=`: `--autodiscover=true`.
If you wish to manually specify which projects that your bot runs again, then add this variable: `RENOVATE_EXTRA_FLAGS="--autodiscover=false group1/repo5 user3/repo1"` (i.e. providing a list of every repository with a space in-between).
If you wish for your bot to run against *every* project which the `RENOVATE_TOKEN` PAT has access to, but which already have a `renovate.json` or similar config file, then add this variable: `RENOVATE_EXTRA_FLAGS`: `--autodiscover=true --onboarding=false`. This will mean no new projects will be onboarded.
If you wish to manually specify which projects that your bot runs again, then add this variable with a space-delimited set of project names: `RENOVATE_EXTRA_FLAGS`: `group1/repo5 user3/repo1`.
If you wish for your bot to run against *every* project which the `RENOVATE_TOKEN` PAT has access to, but specify a filter for which of those projects to run against, then add this variable: `RENOVATE_EXTRA_FLAGS`: `--autodiscover=true --autodiscover-filter=group1/*`.
