docs: new page about Switching bot identity #30445
Conversation
Co-authored-by: Sebastian Poxhofer <secustor@users.noreply.github.com>
|
|
||
| - if a PR is authored by Renovate bot | ||
| - if you, or some other bot, pushed commits into the PR branch | ||
| - Editor note: list other things Renovate uses the bot id for here |
There was a problem hiding this comment.
Do you mean that Renovate uses its bot identity as identifier to the Git-hosting platform (GitHub, for example) to create a update PR?
|
|
||
| - Migrating between Mend-hosted and self-hosted | ||
| - Renaming the bot (self-hosted) | ||
| - Editor note: Maybe there are other reasons too, please comment |
There was a problem hiding this comment.
can be extended later, never had this requirement yet 🙃
| 1. Start of ordered list with steps | ||
| 1. Second step | ||
| 1. Third step, and so on |
There was a problem hiding this comment.
I think you don't need to do much on a simple account rename. 🤔 maybe check if username is set and replace it with new name 🤷♂️
There was a problem hiding this comment.
| 1. Start of ordered list with steps | |
| 1. Second step | |
| 1. Third step, and so on | |
| 1. Confirm the _new_ bot user name is set on your Git-hosting platform | |
| 1. Replace the old bot username with the _new_ bot username |
|
|
||
| ### Other situations | ||
|
|
||
| Editor note: Please comment about other cases where you need to switch bot identity. |
|
|
||
| ## Questions from the editor | ||
|
|
||
| - Is the `gitAuthor` field the bot identity? |
There was a problem hiding this comment.
no, it's used as git author only
There was a problem hiding this comment.
| - Is the `gitAuthor` field the bot identity? |
| ## Questions from the editor | ||
|
|
||
| - Is the `gitAuthor` field the bot identity? | ||
| - What's `gitIgnoredAuthors` for? It looks like you can ignore commits from the old bot with it? |
| - We also have `ignorePrAuthor` which if set to `true` fetches the _whole_ list of PRs, instead of just fetching Renovate PRs. The docs say this is the one to use to ignore old bot names. But the description of `ignorePrAuthor` only mentions the full list fetching, nothing about the name/id of the bot. | ||
| - It's easy to confuse `gitIgnoredAuthors` and `ignorePrAuthor` they have similar names, but do different things. |
There was a problem hiding this comment.
by default renovate only fetches it's own PR's. so to find the others identity PRs, you need to enable ignore PR author. ignore git author's is used to detect user changes, so add the old git author to the list
|
|
||
| - if a PR is authored by Renovate bot | ||
| - if you, or some other bot, pushed commits into the PR branch | ||
| - Editor note: list other things Renovate uses the bot id for here |
There was a problem hiding this comment.
Do you mean that Renovate uses its bot identity as identifier to the Git-hosting platform (GitHub, for example) to create a update PR?
| 1. Start of ordered list with steps | ||
| 1. Second step | ||
| 1. Third step, and so on |
There was a problem hiding this comment.
| 1. Start of ordered list with steps | |
| 1. Second step | |
| 1. Third step, and so on | |
| 1. Confirm the _new_ bot user name is set on your Git-hosting platform | |
| 1. Replace the old bot username with the _new_ bot username |
| ### Other situations | ||
|
|
||
| Editor note: Please comment about other cases where you need to switch bot identity. |
There was a problem hiding this comment.
| ### Other situations | |
| Editor note: Please comment about other cases where you need to switch bot identity. |
If there are no more situations where a user may want/need to switch the Renovate bot ID, we can drop the whole section with this suggestion. 😉
|
|
||
| ## Questions from the editor | ||
|
|
||
| - Is the `gitAuthor` field the bot identity? |
There was a problem hiding this comment.
| - Is the `gitAuthor` field the bot identity? |
Changes
Context
Closes #30385.
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via: