CONTRIB: Automate AUTHORS file update #10308
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yosefe
reviewed
Nov 20, 2024
|
adding to CI imposes PR creators to have their commits under exact email, or name, could this become a problem at some point? |
yosefe
reviewed
Nov 21, 2024
contrib/authors_update.sh
Outdated
Comment on lines
17
to
25
| if [ "$(git log --no-merges --oneline "$range" | wc -l)" -eq 0 ] | ||
| then | ||
| echo "Error: empty range \"$range\"" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Failure triggered if range is not valid | ||
| git --no-pager log --no-merges --oneline --pretty=format:"%h %an <%ae> %s" \ | ||
| "$range" |
There was a problem hiding this comment.
can we do the range validity check in one git command? and if only for validity, why need pretty format?
There was a problem hiding this comment.
ok make sense, retested empty/bad range and patched, that removed the commit list, I think that's also ok since it can be very long.
| git log --no-merges --pretty=format:"%an%x09%ae" "$range" | sort | uniq | \ | ||
| while IFS=$'\t' read -r name email; do | ||
| line="$name <$email>" | ||
| if ! grep -iqw "$email" "$tmp" && ! grep -iq "$name" "$tmp"; then |
There was a problem hiding this comment.
can you pls add comment what this does?
gleon99
reviewed
Nov 21, 2024
contrib/authors_update.sh
Outdated
|
|
||
| if [ ! -w AUTHORS ] | ||
| then | ||
| echo "AUTHORS file not accessible" |
There was a problem hiding this comment.
fixed, but -w also covers the case where file does not exist
contrib/authors_update.sh
Outdated
|
|
||
| set -eEu -o pipefail | ||
|
|
||
| range="${1?Provide commit range like orig/v1.17..orig/v1.18}" |
contrib/authors_update.sh
Outdated
| lines=$(git log --no-merges --pretty=format:"%an%x09%ae" "$range" | sort | uniq) | ||
| if [ -z "$lines" ] | ||
| then | ||
| echo "Error: empty range \"$range\"" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Automate AUTHORS updates according to documentation.
Why?
Seems better to try to have common approach.
How?