DDC-2215: [GH-543] Make doctrine a Light-weight distribution package in Composer #2787

Closed
opened 2026-01-22 14:03:41 +01:00 by admin · 3 comments
Owner

Originally created by @doctrinebot on GitHub (Dec 28, 2012).

Originally assigned to: @beberlei on GitHub.

Jira issue originally created by user @beberlei:

This issue is created automatically through a Github pull request on behalf of carlosbuenosvinos:

Url: https://github.com/doctrine/doctrine2/pull/543

Message:

In order to save space and bandwidth when installing doctrine using Composer, I have added .gitattributes removing files and folders unnecessary when using doctrine 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.

Originally created by @doctrinebot on GitHub (Dec 28, 2012). Originally assigned to: @beberlei on GitHub. Jira issue originally created by user @beberlei: This issue is created automatically through a Github pull request on behalf of carlosbuenosvinos: Url: https://github.com/doctrine/doctrine2/pull/543 Message: In order to save space and bandwidth when installing doctrine using Composer, I have added .gitattributes removing files and folders unnecessary when using doctrine 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.
admin added the Improvement label 2026-01-22 14:03:41 +01:00
admin closed this issue 2026-01-22 14:03:42 +01:00
Author
Owner

@doctrinebot commented on GitHub (Jan 19, 2013):

Issue was closed with resolution "Fixed"

@doctrinebot commented on GitHub (Jan 19, 2013): Issue was closed with resolution "Fixed"
Author
Owner

@doctrinebot commented on GitHub (Mar 14, 2014):

Comment created by @doctrinebot:

A related Github Pull-Request [GH-543] was closed:
https://github.com/doctrine/dbal/pull/543

@doctrinebot commented on GitHub (Mar 14, 2014): Comment created by @doctrinebot: A related Github Pull-Request [GH-543] was closed: https://github.com/doctrine/dbal/pull/543
Author
Owner

@doctrinebot commented on GitHub (Dec 30, 2014):

Comment created by @doctrinebot:

A related Github Pull-Request [GH-543] was assigned:
https://github.com/doctrine/doctrine2/pull/543

@doctrinebot commented on GitHub (Dec 30, 2014): Comment created by @doctrinebot: A related Github Pull-Request [GH-543] was assigned: https://github.com/doctrine/doctrine2/pull/543
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: doctrine/archived-orm#2787