Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add documentation for forkToken #9701

Merged
merged 9 commits into from Apr 24, 2021
8 changes: 8 additions & 0 deletions docs/usage/self-hosted-configuration.md
Expand Up @@ -200,6 +200,14 @@ It will also override any settings in `packageRules`.
## forkMode

You probably have no need for this option - it is an experimental setting for the Renovate hosted GitHub App.
However, if this is set to `true` then Renovate will fork the repository into the personal space of the person owning the Personal Access Token.
Chumper marked this conversation as resolved.
Show resolved Hide resolved

## forkToken
Chumper marked this conversation as resolved.
Show resolved Hide resolved

You probably have no need for this option - it is an experimental setting for the Renovate hosted GitHub App.
This should be set to a Personal Access Token (GitHub only) when `forkMode` is set to `true`.
Renovate will use this token to fork the repository into the personal space of the person owning the Personal Access Token.
Renovate will then create branches on the fork and opens Pull Requests on the parent repository.

## gitAuthor

Expand Down
9 changes: 9 additions & 0 deletions lib/config/definitions.ts
Expand Up @@ -340,6 +340,15 @@ const options: RenovateOptions[] = [
default: false,
admin: true,
},
{
name: 'forkToken',
description:
'Will be used on GitHub when `forkMode` is set to `true` to clone the repositories.',
stage: 'repository',
type: 'string',
default: '',
admin: true,
},
{
name: 'requireConfig',
description: 'Set to true if repositories must have a config to activate.',
Expand Down