From decd25432c74f9d4cbab98fccb28b16bd999d23e Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Thu, 24 Mar 2022 10:29:28 +0100 Subject: [PATCH] docs(config options): rewrite platformCommit section (#14685) --- docs/usage/configuration-options.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md index 95e2578246..c8eb2d5793 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 -- GitLab