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.

Sign up for GitHub

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

Jump to bottom

docs: add documentation for forkToken #9701

Merged
merged 9 commits into from Apr 24, 2021
Merged

docs: add documentation for forkToken #9701

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a7ad21d
docs: add documentation for forkToken
Chumper Apr 23, 2021
00221a2
fix: add forkToken to the definitions file
Chumper Apr 23, 2021
3df82c1
Merge branch 'master' into chore/forkToken
Chumper Apr 23, 2021
4835ea4
Merge branch 'main' into chore/forkToken
Chumper Apr 23, 2021
885f524
Update docs/usage/self-hosted-configuration.md
Chumper Apr 23, 2021
6e278ae
docs: rephrase documentation
Chumper Apr 23, 2021
9c6b7fb
docs: better wording
Chumper Apr 23, 2021
b995c36
Update docs/usage/self-hosted-configuration.md
Chumper Apr 23, 2021
9f87429
Merge branch 'main' into chore/forkToken
rarkins Apr 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/usage/self-hosted-configuration.md
View file
Open in desktop
Expand Up @@ -200,6 +200,13 @@ 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 clone the repository before working on the clone and creating Pull Requests on the parent (GitHub only).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
However, if this is set to true then Renovate will clone the repository before working on the clone and creating Pull Requests on the parent (GitHub only).
However, if this is set to `true` then Renovate will clone the repository before working on the clone and creating Pull Requests on the parent (GitHub only).

Let's put true in monospaced font.

Also it's really confusing to read: "Renovate will clone the repository before working on the clone"...
I don't know what the behavior is, but the way its worded now is not helping me understand what's happening.

The way I understand Renovate is that it always clones the repo before doing stuff???

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, wording is misleading, I meant fork instead of clone. Let me rephrase.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct, wording is misleading, I meant fork instead of clone. Let me rephrase.

I thought some wires got crossed somewhere. 😄
I'll let you rephrase this. 😉

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated the wording, does it make more sense now?


## 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`.
Chumper marked this conversation as resolved.
Show resolved Hide resolved
Renovate will use this token to clone the repository and to create Pull Requests on the parent.

## gitAuthor

Expand Down
9 changes: 9 additions & 0 deletions lib/config/definitions.ts
View file
Open in desktop
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