static: Don't ship READMEs in static archives#463
Open
vvoland wants to merge 1 commit into
Open
Conversation
READMEs copied into the archives are the upstream GitHub repository READMEs. They add no value as they mostly describe the project for contributors browsing source and not users consuming a binary release. LICENSE files are kept. Signed-off-by: Paweł Gronowski <pawel.gronowski@docker.com>
Member
|
We need to review each of these, because I think the README was added for similar reasons that go mod (vendor) includes it; often the LICENSE itself is not applying the license (only a "convenience"), and the README, NOTICE (and sometimes PATENTS) files may contain legal information on the license. eg; https://github.com/docker/cli/tree/v29.6.1#legal I think for that one it's mostly redundant / duplicate, but for example this one adds another license (for docs); https://github.com/distribution/distribution/tree/v3.1.1#licenses |
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.
Remove README.md from the files copied into static tarballs/zips across all packages. LICENSEs are kept; READMEs add no value to a binary release archive and just inflate the output.
For containerd, also drop the component-scoped runhcs.README.md and runc.README.md that were copied alongside the main project README.