{"id":25044972,"url":"https://github.com/sectorlabs/heroku-buildpack-git-submodule","last_synced_at":"2025-04-14T02:01:44.038Z","repository":{"id":56355548,"uuid":"88905945","full_name":"SectorLabs/heroku-buildpack-git-submodule","owner":"SectorLabs","description":"🦆 Adding support for Git submodules to Heroku apps.","archived":false,"fork":false,"pushed_at":"2023-04-03T03:44:36.000Z","size":10,"stargazers_count":36,"open_issues_count":2,"forks_count":57,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-04T01:32:33.558Z","etag":null,"topics":["buildpack","git","heroku"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SectorLabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-20T20:05:43.000Z","updated_at":"2024-09-08T07:41:41.000Z","dependencies_parsed_at":"2024-08-01T13:25:09.091Z","dependency_job_id":"ad5808ce-0ad6-4d15-8eb9-cad9829c1223","html_url":"https://github.com/SectorLabs/heroku-buildpack-git-submodule","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SectorLabs%2Fheroku-buildpack-git-submodule","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SectorLabs%2Fheroku-buildpack-git-submodule/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SectorLabs%2Fheroku-buildpack-git-submodule/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SectorLabs%2Fheroku-buildpack-git-submodule/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SectorLabs","download_url":"https://codeload.github.com/SectorLabs/heroku-buildpack-git-submodule/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248809032,"owners_count":21164895,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["buildpack","git","heroku"],"created_at":"2025-02-06T05:20:06.856Z","updated_at":"2025-04-14T02:01:43.936Z","avatar_url":"https://github.com/SectorLabs.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"![license](https://camo.githubusercontent.com/7564c4f51086d05c91ab09865b0ab1eaf457f172/68747470733a2f2f696d672e736869656c64732e696f2f3a6c6963656e73652d6d69742d626c75652e737667) ![heroku stack](https://img.shields.io/badge/heroku%20stack-cedar14-green.svg)\n\n![heroku](http://i.imgur.com/gdl3WtA.png)\n\nThis Heroku buildpack adds support for Git submodules. This allows submodules to work with Github Sync. Heroku supports submodules natively, but only through Git pushes. This works around that limitation.\n\n## Why?\nOthers have attempted to provide this functionality by manually parsing the `.gitmodules` file. This is an unreliable methods. This is because the `.gitmodules` file only describes certain things about the submodules. The exact commit hash a submodule is bound to is actually stored in Git's object tree. Relying solely on `.gitmodules` to fetch submodules is therefor insufficient.\n\nThis buildpack takes a different approach and makes using the native Git way of resolving submodules work. It does this by actually fetching the Git objects. Normally this is lost during deployment, but this buildpack works around that. After that, it's a matter of executing `git submodule update --init --recursive`.\n\n## Usage\n\n1. Add the buildpack to your Heroku app:\n\n        heroku buildpacks:add https://github.com/SectorLabs/heroku-buildpack-git-submodule.git\n        \n    Keep in mind that the buildpack order is important. If you'll specify this buildpack after your default one (e.g. `heroku/nodejs`) it'll not work. See [https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app](https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app) for details.\n\n2. Set the `GIT_REPO_URL` to the SSH URL of your Git repo:\n\n        heroku config:set GIT_REPO_URL=git@github.com:SectorLabs/myrepo\n\n3. Set `GIT_SSH_KEY` to the private SSH key that can access both your repo and its submodules:\n\n        heroku config:set GIT_SSH_KEY=\"$(cat ~/.ssh/id_rsa)\"\n\n4. Enjoy the ride :)\n\n## Limitations\n1. SSH Authentication only.\n\n## License\n```\nMIT License\n\nCopyright (c) 2017 Sector Labs\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsectorlabs%2Fheroku-buildpack-git-submodule","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsectorlabs%2Fheroku-buildpack-git-submodule","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsectorlabs%2Fheroku-buildpack-git-submodule/lists"}