[CXX-1180] Exclude files/dirs from git-generated archive files Created: 21/Dec/16  Updated: 07/Feb/17  Resolved: 07/Feb/17

Status: Closed
Project: C++ Driver
Component/s: Meta
Affects Version/s: None
Fix Version/s: 3.2.0-rc0

Type: Task Priority: Trivial - P5
Reporter: David Golden Assignee: Samuel Rossi (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

GitHub releases are generated from git archive and we can use the .gitattributes file to exclude files. I think there's a good case to be made that the tarball should omit "developer" files so it's as small and focused as possible.

Candidates for inclusion:

  • /.* – exclude all dot files, including .evergreen, .gitignore, .travis.yml etc.
  • /appveyor.yml – just like excluding .travis.yml
  • /docs – exclude all the hugo source files and HTML template for the docs site
  • /etc – exclude all these development helpers

The downside of removing things like docs and etc is that some developer build targets will be broken, but I don't think that will have an impact on the typical user. Anyone who wants a "developer's view" of the code should clone the repo.



 Comments   
Comment by Githook User [ 07/Feb/17 ]

Author:

{u'username': u'saghm', u'name': u'Saghm Rossi', u'email': u'saghmrossi@gmail.com'}

Message: CXX-1180 Exclude files/dirs from git-generated archive files
Branch: master
https://github.com/mongodb/mongo-cxx-driver/commit/02563639845de3f7511be361f42a3371c994df51

Comment by Andrew Morrow (Inactive) [ 21/Dec/16 ]

Seems reasonable to me. I've wanted to make use of git archive and gitattributes for a while to improve some other aspects of the git tarball related to release process. This seems like a good way to gain familiarity with how it works and make sure it does what we want.

Generated at Wed Feb 07 22:01:40 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.