diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 95e2578246cf52b2e8ac8e74c98345cf318eff93..c8eb2d5793646783d468afad684516ef4148a641 100644 --- a/docs/usage/configuration-options.md +++ b/docs/usage/configuration-options.md @@ -1837,11 +1837,11 @@ For example, GitHub might automerge a Renovate branch even if it's behind the ba ## platformCommit -Supports only GitHub App mode and not when using Personal Access Tokens. +Only use this option if you run Renovate as a [GitHub App](https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps). +It does not apply when you use a Personal Access Token as credential. -To avoid errors, `gitAuthor` or `gitIgnoredAuthors` should be manually adjusted accordingly. - -The primary reason to use this option is because commits will then be signed automatically if authenticating as an app. +When `platformCommit` is enabled, Renovate will create commits with GitHub's API instead of using `git` directly. +This way Renovate can use GitHub's [Commit signing support for bots and other GitHub Apps](https://github.blog/2019-08-15-commit-signing-support-for-bots-and-other-github-apps/) feature. ## postUpdateOptions