Remove CONTRIBUTORS.txt line from license headers#151
Merged
guoye-zhang merged 1 commit intoapple:mainfrom Apr 20, 2026
Merged
Conversation
There is no CONTRIBUTORS.txt in this repo, and the project is moving away from maintaining one. Drop the '// See CONTRIBUTORS.txt for the list of ...' line from every source file's license header. Introduce a .license_header_template so the soundness license header check uses the project-local template (without the CONTRIBUTORS.txt line) instead of the default template supplied by swiftlang's shared soundness workflow. Fixes apple#59.
guoye-zhang
approved these changes
Apr 20, 2026
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
2 participants
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.
Motivation
Fixes #59.
The repo does not ship a
CONTRIBUTORS.txt, but every source file's license header contains:The soundness license-header check enforces this line because the shared workflow at
swiftlang/github-workflows/.github/workflows/scripts/check-license-header.shbakes it into the default template. The issue notes that other Swift OSS projects are also moving away fromCONTRIBUTORS.txt, so it should be dropped from the headers and the CI template.Modifications
.license_header_template(without theCONTRIBUTORS.txtline). The soundness script honors this file and uses it instead of the default template.// See CONTRIBUTORS.txt for the list of Swift HTTP API Proposal project authorsline from the header of every.swiftfile underSources/,Tests/, andExamples/(99 files).No other bytes in the headers were changed. The soundness workflow invocation was left as-is;
license_header_check_project_nameis unused when a local template exists, but keeping the input avoids a second churn if the template is ever removed.Result
The license-header soundness check passes against the project-local template, and every source file's header reflects the reality that there is no
CONTRIBUTORS.txt.Test Plan
Ran the upstream soundness script against the checked-out tree:
(The script is fetched from
swiftlang/github-workflows@main, which is the same workflow this repo invokes in.github/workflows/pull_request.yml.)