Exclude development stuff from repository autogenerated ZIP archives #555

Merged
merged 1 commit into from Jun 7, 2016

Projects

None yet

3 participants

@mlocati
Contributor
mlocati commented May 19, 2016

People that install this library via composer don't need the test/sample stuff, they just need the library itself.
This PR removes the development directories and files from the repository auto-generated ZIP archives.
Since these development files/directories will still be available via git clone, Travis is happy, developers are happy, and so are end-users (they won't have unneeded stuff in production machines).

@mlocati mlocati Exclude development stuff from repository autogenerated ZIP archives
People that install this library via composer don't need the test/sample stuff, they just need the library itself.
This PR removes the development directories and files from the repository auto-generated ZIP archives.
Since these development files/directories will still be available via `git clone`, Travis is happy, developers are happy, and so are end-users (they won't have unneeded stuff in production machines).
57f0b33
@serbanghita serbanghita merged commit 3b22fe2 into serbanghita:master Jun 7, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@ThaDafinser
ThaDafinser commented Jun 7, 2016 edited

More and more repos exclude that files, but i think it's not worth.

Since now you cannot download the repo anymore and try out the examples...

@mlocati
Contributor
mlocati commented Jun 7, 2016

Since now you cannot download the repo anymore and try out the examples...

git clone is enough to get everything you want

@mlocati mlocati deleted the mlocati:patch-1 branch Jun 7, 2016
@ThaDafinser

I know that, but still there are enough people that don't know how to use git....they are stuck with this change.

Also with composer you can still do --prefer-source

@mlocati
Contributor
mlocati commented Jun 7, 2016

I don't think that examples and tests should be kept in the distribution of the packages.
And here's why:

  • examples are useful only once (while developing)
  • developers can see the examples by using
    • git clone
    • composer install --prefer-source
    • browsing to GitHub
@serbanghita
Owner
serbanghita commented Jun 7, 2016 edited

Thanks for sharing your thoughts! I'm testing this on master. I'm trying to think of all use cases and be back with a conclusion.

@mlocati
Contributor
mlocati commented Jun 7, 2016 edited

There's also a forthcoming project that @kamilsk is developing: https://github.com/octolab/Cleaner

That project is a Composer plugin that can remove some files/directories specified by package maintainers (that files can be grouped in categories, like tests, documentation, ...), so that when we deploy we can automatically remove the production-useless files

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment