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

Conversation

slonim-greg
Copy link
Contributor

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 overrides RENOVATE_GIT_AUTHOR , it is often important to supply both NAME and EMAIL according to RFC-5322.

Documentation (please check one with an [x])

  • I have updated the documentation

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@slonim-greg slonim-greg changed the title Add clarification for gitAuthor format to avoid obscure errors during commits. Docs: Add clarification for gitAuthor format to avoid obscure errors during commits. Jul 24, 2023
@slonim-greg slonim-greg changed the title Docs: Add clarification for gitAuthor format to avoid obscure errors during commits. docs(config): add clarification for gitAuthor format to avoid obscure errors during commits. Jul 24, 2023
Copy link
Collaborator

@rarkins rarkins left a 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

@slonim-greg
Copy link
Contributor Author

It would not hurt to include, however, to avoid similar problems, even when a platform does not require it, right?

@rarkins
Copy link
Collaborator

rarkins commented Jul 24, 2023

I prefer not to tell something is required if it's only required for edge cases or a subset of platforms

@slonim-greg
Copy link
Contributor Author

It was a problem for our repository; Moreover, the default setting in the "standard issue" Renovate Runner repo has the name there.
We can change the docs language to say that if one encounters the problem I saw, this is what they should do.
In reality though, this is a pretty low hanging fruit and seems pretty innocuous to include if one overrides this config value.
Thoughts?

docs/usage/configuration-options.md Outdated Show resolved Hide resolved
Co-authored-by: Rhys Arkins <rhys@arkins.net>
rarkins
rarkins previously approved these changes Jul 25, 2023
@rarkins rarkins enabled auto-merge July 25, 2023 11:07
auto-merge was automatically disabled July 25, 2023 11:58

Head branch was pushed to by a user without write access

@rarkins rarkins enabled auto-merge July 25, 2023 12:05
rarkins
rarkins previously approved these changes Jul 25, 2023
auto-merge was automatically disabled July 25, 2023 12:27

Head branch was pushed to by a user without write access

@rarkins rarkins enabled auto-merge July 25, 2023 13:17
@rarkins rarkins added this pull request to the merge queue Jul 25, 2023
Merged via the queue into renovatebot:main with commit 89621be Jul 25, 2023
38 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants