Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(config): add clarification for gitAuthor format to avoid obscure errors during commits. #23543

Merged
merged 7 commits into from
Jul 25, 2023
6 changes: 5 additions & 1 deletion docs/usage/configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -1105,7 +1105,11 @@
## 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.
```

Check failure on line 1110 in docs/usage/configuration-options.md

View workflow job for this annotation

GitHub Actions / lint-docs

Fenced code blocks should be surrounded by blank lines

docs/usage/configuration-options.md:1110 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.29.0/doc/md031.md
Development Bot <dev-bot@my-software-company.com>
```

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