Skip to content

Commit

Permalink
docs(config): add clarification for gitAuthor format to avoid obscure…
Browse files Browse the repository at this point in the history
… errors during commits. (#23543)

Co-authored-by: Rhys Arkins <rhys@arkins.net>
  • Loading branch information
slonim-greg and rarkins committed Jul 25, 2023
1 parent 39c9072 commit 89621be
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/usage/configuration-options.md
Expand Up @@ -1105,7 +1105,12 @@ You can't use other filenames because Renovate only checks the default filename
## gitAuthor

You can customize the Git author that's used whenever Renovate creates a commit.
The `gitAuthor` option accepts a RFC5322-compliant string.
The `gitAuthor` option accepts a [RFC5322](https://datatracker.ietf.org/doc/html/rfc5322)-compliant string.
It's recommended to include a name followed by an email address, e.g.

```
Development Bot <dev-bot@my-software-company.com>
```

<!-- prettier-ignore -->
!!! danger
Expand Down

0 comments on commit 89621be

Please sign in to comment.