Make Twig a Composer "light-weight-distribution-package" #942
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
| AUTHORS export-ignore | ||
| CHANGELOG export-ignore | ||
| phpunit.xml.dist export-ignore | ||
| README.markdown export-ignore |
There was a problem hiding this comment.
Please don't ignore the readme and the changelog. These files are meant to be read by the users.
|
Done! |
|
Closing this as the benefits are very small compared to the drawbacks. (see symfony/symfony#6605 for more information). |
fabpot
added a commit
that referenced
this pull request
Oct 17, 2019
This PR was squashed before being merged into the 2.x branch (closes #3153). Discussion ---------- Update .gitattributes to remove tests from "dist" This was proposed many times before, but considering symfony/symfony#33579 is now merged, I propose this again. I refer to that issue as for the reasoning, as it applies here also. I did not add the `docs` directory as there was much discussion about that before (discussion in #942) Related: #942 #1776 #1981 #2292 #2799 2905 Commits ------- 5cde1f5 Update .gitattributes to remove tests from \"dist\"
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.
In order to save space and bandwidth when installing Twig using Composer, I have added .gitattributes removing files and folders unnecessary when using Twig as a dependecy.
(extracted from http://getcomposer.org/doc/02-libraries.md#light-weight-distribution-packages)
Including the tests and other useless information like .travis.yml in distributed packages is not a good idea.
The .gitattributes file is a git specific file like .gitignore also living at the root directory of your library. It overrides local and global configuration (.git/config and ~/.gitconfig respectively) when present and tracked by git.
Use .gitattributes to prevent unwanted files from bloating the zip distribution packages.
// .gitattributes
/Tests export-ignore
phpunit.xml.dist export-ignore
Resources/doc/ export-ignore
.travis.yml export-ignore
Test it by inspecting the zip file generated manually:
git archive branchName --format zip -o file.zip
Note: Files would be still tracked by git just not included in the distribution. This will only work for GitHub packages installed from dist (i.e. tagged releases) for now.