{"id":5428,"date":"2019-07-03T11:27:21","date_gmt":"2019-07-03T16:27:21","guid":{"rendered":"https:\/\/www.rushworth.us\/lisa\/?p=5428"},"modified":"2019-08-01T20:34:00","modified_gmt":"2019-08-02T01:34:00","slug":"sparse-checkout-with-git","status":"publish","type":"post","link":"https:\/\/www.rushworth.us\/lisa\/?p=5428","title":{"rendered":"Sparse Checkout With Git"},"content":{"rendered":"

I’ve encountered a few repositories that are huge. Unwieldy huge, and stuffed with files that aren’t relevant to what I<\/em> need. The straight-forward solution is to use multiple repositories — that’s what I do at work with my code samples. There’s a different repo for each language because the PHP developers really don’t care what the C# code looks like. The Java developers don’t need a copy of the Python code. But there are advantages to having a single repository that may preclude you from taking the simple solution. Git sub-modules<\/a> are an interesting approach — combining multiple repositories into a single functional unit. But that’s a pretty big change to an existing repo. And, if you participate in open source projects, it may not be your decision anyway.<\/p>\n

There’s another option for selectively cloning when you’re working with a large repo — an option that doesn’t require any changes to the repository. An end user can perform a sparse<\/em> checkout — essentially use a filter like .gitignore to select or deselect certain files\/folders from being pulled into the local working directory. The file is named sparse-checkout and is located in .git\\info — unlike a .gitignore file which indicates what shouldn’t<\/em> get included, sparse-checking controls what is<\/em> included (if you want an entire repo except<\/em> one folder, use !path\/to\/folder\/**)<\/p>\n

The sparse-checkout file used to get just<\/em> the core components of Scott’s OpenHAB helper libraries plus the OpenWeatherMap community scripts is:<\/p>\n

.github\/**\r\nCore\/**\r\nCommunity\/OpenWeatherMap\/**<\/pre>\n
To use sparse checkout, set the core.sparseCheckout config value to true. You can add sparse checkout to a repo you’ve already cloned and use<\/p>\n
git read-tree -mu HEAD<\/pre>\n
to “clean up” unwanted files. Or you can set up sparse checkout before you clone the repo<\/p>\n
D:\\tmp>mkdir ljrtest<\/strong>\r\n\r\nD:\\tmp>cd ljrtest<\/strong>\r\n\r\nD:\\tmp\\ljrtest>git init\r\n<\/strong>Initialized empty Git repository in D:\/tmp\/ljrtest\/.git\/\r\n\r\nD:\\tmp\\ljrtest>git remote add origin https:\/\/github.com\/openhab-scripters\/openhab-helper-libraries<\/strong>\r\n\r\nD:\\tmp\\ljrtest>git config core.sparseCheckout true<\/strong>\r\n\r\nD:\\tmp\\ljrtest>copy ..\\sparse-checkout .git\\info\\<\/strong>\r\n1 file(s) copied.\r\n\r\nD:\\tmp\\ljrtest>git pull origin master<\/strong>\r\nremote: Enumerating objects: 3591, done.\r\nremote: Total 3591 (delta 0), reused 0 (delta 0), pack-reused 3591R ), 7.00 MiB | 6.95 MiB\/s\r\nReceiving objects: 100% (3591\/3591), 9.26 MiB | 7.22 MiB\/s, done.\r\nResolving deltas: 100% (1786\/1786), done.\r\nFrom https:\/\/github.com\/openhab-scripters\/openhab-helper-libraries\r\n* branch master -> FETCH_HEAD\r\n* [new branch] master -> origin\/master\r\n\r\nD:\\tmp\\ljrtest>dir<\/strong>\r\nVolume in drive D is DATA\r\nVolume Serial Number is D8E9-3B61\r\n\r\nDirectory of D:\\tmp\\ljrtest\r\n\r\n07\/03\/2019 09:07 AM <DIR> .\r\n07\/03\/2019 09:07 AM <DIR> ..\r\n07\/03\/2019 09:07 AM <DIR> .github\r\n07\/03\/2019 09:07 AM <DIR> Community\r\n07\/03\/2019 09:07 AM <DIR> Core\r\n0 File(s) 0 bytes\r\n5 Dir(s) 386,515,042,304 bytes free\r\n\r\nD:\\tmp\\ljrtest>dir .\\Community<\/strong>\r\nVolume in drive D is DATA\r\nVolume Serial Number is D8E9-3B61\r\n\r\nDirectory of D:\\tmp\\ljrtest\\Community\r\n\r\n07\/03\/2019 09:07 AM <DIR> .\r\n07\/03\/2019 09:07 AM <DIR> ..\r\n07\/03\/2019 09:07 AM <DIR> OpenWeatherMap\r\n0 File(s) 0 bytes\r\n3 Dir(s) 386,515,042,304 bytes free<\/pre>\n
Using sparse checkout, no one else has to do anything<\/em>. Configure your client to get the files you want, and you’re set.<\/p>\n
 <\/p>\n","protected":false},"excerpt":{"rendered":"
I’ve encountered a few repositories that are huge. Unwieldy huge, and stuffed with files that aren’t relevant to what I need. The straight-forward solution is to use multiple repositories — that’s what I do at work with my code samples. There’s a different repo for each language because the PHP developers really don’t care what …<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[33],"tags":[233],"class_list":["post-5428","post","type-post","status-publish","format-standard","hentry","category-coding","tag-git"],"_links":{"self":[{"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/posts\/5428","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=5428"}],"version-history":[{"count":4,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/posts\/5428\/revisions"}],"predecessor-version":[{"id":5492,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=\/wp\/v2\/posts\/5428\/revisions\/5492"}],"wp:attachment":[{"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5428"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=5428"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.rushworth.us\/lisa\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=5428"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}