Make CONTRIBUTORS.txt optional in license headers#268
Open
crleonard wants to merge 2 commits intoswiftlang:mainfrom
Open
Make CONTRIBUTORS.txt optional in license headers#268crleonard wants to merge 2 commits intoswiftlang:mainfrom
crleonard wants to merge 2 commits intoswiftlang:mainfrom
Conversation
This file contains hidden or 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
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.
Summary
#267
Update the shared license header check so source headers can omit the
CONTRIBUTORS.txtline.Some Swift repositories have removed
CONTRIBUTORS.txt, so requiring this linein every source header leaves stale references behind. The check now continues
to accept existing headers that include the line, but also accepts headers where
the line has been removed.
Details
The checker still validates the full expected header first. If that comparison
fails, it retries after removing any
CONTRIBUTORS.txtline from both theexpected header and the file header.
This keeps compatibility for repositories that still include the line while
allowing repositories that have removed
CONTRIBUTORS.txtto update theirheaders.
Testing
Added
tests/check-license-header.sh, which creates a temporary git repo withtwo Swift files:
CONTRIBUTORS.txtlineCONTRIBUTORS.txtlineBoth are checked using the real license header script.
Manually verified with: