Doctrine 2 - ORM
  1. Doctrine 2 - ORM
  2. DDC-2215

[GH-543] Make doctrine a Light-weight distribution package in Composer

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.4
    • Component/s: None
    • Security Level: All
    • Labels:
      None

      Description

      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.

        Activity

        Hide
        Doctrine Bot added a comment -

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

        Show
        Doctrine Bot added a comment - A related Github Pull-Request [GH-543] was closed: https://github.com/doctrine/dbal/pull/543

          People

          • Assignee:
            Benjamin Eberlei
            Reporter:
            Benjamin Eberlei
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: