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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure every platform requires both name and email
It would not hurt to include, however, to avoid similar problems, even when a platform does not require it, right? |
I prefer not to tell something is required if it's only required for edge cases or a subset of platforms |
It was a problem for our repository; Moreover, the default setting in the "standard issue" Renovate Runner repo has the name there. |
Co-authored-by: Rhys Arkins <rhys@arkins.net>
Head branch was pushed to by a user without write access
Head branch was pushed to by a user without write access
Changes
Add documentation clarification for
gitAuthor
config option.Closes #23538
Context
The context for this change is documented in Issue 23538.
Bottom line:
If one supplies
gitAuthor
or overridesRENOVATE_GIT_AUTHOR
, it is often important to supply both NAME and EMAIL according to RFC-5322.Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via: