docs: add documentation for forkToken #9701
Conversation
| @@ -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). | |||
There was a problem hiding this comment.
| 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???
There was a problem hiding this comment.
Correct, wording is misleading, I meant fork instead of clone. Let me rephrase.
There was a problem hiding this comment.
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. 😉
There was a problem hiding this comment.
I have updated the wording, does it make more sense now?
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
|
|
Chumper
force-pushed
the
chore/forkToken
branch
from
ea0e127
to
6e278ae
Compare
There was a problem hiding this comment.
I've made a suggestion to fix up a line of text.
I'm not clear on what "personal space" refers to. What/where is this "personal space"? Do we need to use this term to understand what the feature does differently compare to the default Renovate bot behavior? I'm thinking that maybe this is too much detail and will only confuse readers? But maybe we do need to explain this concept?
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
|
The personal space for me is where all repos under https://github.com/Chumper?tab=repositories are, so all repos that are not under an organization like Maybe As a PAT always belongs to a user account on GitHub, there is always a personal space where repositories can be forked into. |
|
🎉 This PR is included in version 25.3.3 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Changes:
Added documentation
Context:
I provide the forking GitHub App as well internally in the company.
So I completed the documentation for this workflow
Documentation (please check one with an [x])
How I've tested my work (please tick one)
I have verified these changes via: