renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-12 06:56:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

docs: add documentation for forkToken (#9701)

Browse source
This commit is contained in:
Nils Plaschke 2021-04-24 07:54:00 +02:00 committed by GitHub
parent e366da2ad5
commit 90e96805e1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/usage/self-hosted-configuration.md
View file

@ -200,6 +200,14 @@ It will also override any settings in `packageRules`.
## forkMode ## forkMode
You probably have no need for this option - it is an experimental setting for the Renovate hosted GitHub App. 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 ## gitAuthor

9
lib/config/definitions.ts
View file

@ -340,6 +340,15 @@ const options: RenovateOptions[] = [
default: false, default: false,
admin: true, 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', name: 'requireConfig',
description: 'Set to true if repositories must have a config to activate.', description: 'Set to true if repositories must have a config to activate.',