findologic / libflexport

FINDOLOGIC export toolkit for XML and CSV data export

MIT License

4 stars 5 forks source link

Reduce release archive size by ignoring files and directories #109

Closed mmachatschek closed 4 years ago

mmachatschek commented 5 years ago

Purpose

The current archive is bloated with irrelevant package information for implementers.

This PR:

reduces archive size and
helps to publish only the essentials of the library

Approach

Add .gitattributes file with the excluded file paths.

Open Questions and Pre-Merge TODOs

[x] ~~composer lint and composer fix was executed.~~ No changes to the code!
[x] ~~Tests were written and pass with 100% coverage.~~ No changes to the code!
[x] ~~A issue with a detailed explanation of the problem/enhancement was created and linked.~~ See purpose and approach.

codecov-io commented 5 years ago

Codecov Report

Merging #109 into develop will not change coverage. The diff coverage is n/a.

@@           Coverage Diff            @@
##             develop   #109   +/-   ##
========================================
  Coverage        100%   100%           
  Complexity       265    265           
========================================
  Files             49     49           
  Lines            694    694           
========================================
  Hits             694    694

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 71d0eb9...863eb55. Read the comment docs.

mmachatschek commented 4 years ago

@dblaichinger oder @howard ;)

dblaichinger commented 4 years ago

@mmachatschek Thanks for the reminder, I talked already with @howard, he will take care of it, but is currently on vacation.

howard commented 4 years ago

@mmachatschek @dblaichinger I'm not exactly sure if we want this change. When the repo is archived, it's not 100% clear what the intention is of the person who is going to download it. If that includes development work on libflexport, then important stuff would be missing.

As for the run time, we're already separating tests from prod code in the autoloader, so no benefits there.

Please clarify!

howard commented 4 years ago

Also, I checked a bunch of other PHP projects and they don't seem to exclude this stuff for distribution.

mmachatschek commented 4 years ago

@howard @dblaichinger as there is no platform where libflexport is published to except packagist and github itself, you would not download the archived version from the release page.

I haven't seen anyone going the vendor folder and checking the .github folder or examples. I see if you check the code, that in a IDE the tests folder would be helpful but everything else is not really useful to implementers. Most of the time your go to the documantation page, wiki, github etc. to check how the library works.

e.g. repos -> laravel/framework, most laravel packages from the vendor in general, most symfony packages have the .gitattributes file set.

Your probably don't find much packages out there because few now about this .gitattributes trick :)

howard commented 4 years ago

@mmachatschek Makes sense now. Thanks for the explanation, and the contribution!