Add missing EGSnrc contributor names since 2015 #966
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
ftessier
force-pushed
the
add-missing-contributors
branch
3 times, most recently
from
1ed3b68
to
e8b2eb6
Compare
mxxo
reviewed
Feb 19, 2023
| # Max Orok | ||
| # Reid Townson |
There was a problem hiding this comment.
Double Reid seems to be added here?
Authors of the EGSnrc files are unequivocally identified in the git commit log. However, we also want to preserve the names of authors and contributors inside text files headers, as much as possible, in case the files are extracted from the repository (or the repository eventually moves to another version control system). This script compares, for each modified file in a commit range (passed as the first argument, master..HEAD by default), the commit authors of the file against the authors and contributors listed in the file header. It reports the missing names, and returns 1 (error) if some authors are missing, or 0 (success) otherwise. Binary files are excluded from the comparison, as well as files that do not contain authorship information. The latter are reported at the end of the output, skipping over files that do not contain author information (e.g., image files). This script is intended to run automatically as a github action. It implies that all commit authors should be listed under "Contributors", regardless of the significance of the contribution, so that the script runs cleanly. The output of the github action should always be inspected before merging to check the files that don't contain authorship information.
ftessier
force-pushed
the
add-missing-contributors
branch
from
e8b2eb6
to
a8db07d
Compare
ftessier
force-pushed
the
add-missing-contributors
branch
from
0b255d5
to
2887a34
Compare
rtownson
approved these changes
Aug 3, 2023
blakewalters
approved these changes
Jun 12, 2024
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.
Add a fish script to check if contributor names are missing from the
Contributors:list, according to commit authors. This script is meant to become a blocking github action for every pull request, but for the moment it can be run manually, e.g., asfish HEN_HOUSE/scripts/admin/check-authors.fishto review authorship of files that have been modified compared to themasterbranch (or add a commit reference as an argument to check since that commit)Add the missing names of people who have modified EGSnrc files since the port to github in 2015(commit 4534cdd). The names are added under the
Contributors:list in the file header. After this change,check-authors.fish 4534cdd4..runs clean.