Suggest adding a .gitattributes file

wbond / packagecontrol.io

The Package Control website

https://packagecontrol.io

Other

111 stars 46 forks source link

Suggest adding a .gitattributes file #125

Open Calvin-L opened 3 years ago

Calvin-L commented 3 years ago

While working on wbond/package_control_channel#8090, I was surprised to learn that there is a way to exclude files from the final package.

FichteFoll commented 3 years ago

While I don't know whether we want to suggest this as a general way around such issues, it should definitely mention that this affects all types of archives you create for a git repo, including from the command line and all sorts of archives downloadable from github.

It is definitely a solution for some, but I wouldn't feel good just suggesting the option without its downsides.

Calvin-L commented 3 years ago

Thanks for pointing that out; I've amended the text to note the potential downsides.

Perhaps this PR should be rejected, and something else should be added to the docs. Now that I understand this a little better, it seems like there is a real use case for some mechanism that

excludes files from the packages distributed to end-users, but
does not affect developer activities like downloading release archives from GitHub.

Does such a mechanism exist? I don't see one mentioned anywhere.