Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
docs: add documentation for forkToken (#9701)
  • Loading branch information
Chumper committed Apr 24, 2021
1 parent e366da2 commit 90e9680
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
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.
If this is set to `true` then Renovate will fork the repository into the personal space of the person owning the Personal Access Token.

## forkToken

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

0 comments on commit 90e9680

Please sign in to comment.