Skip to content

Unity-Engineering-software-engineering/heroku-buildpack-git-submodule

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

license heroku stack

heroku

This 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.

Why?

Others 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.

This 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.

Usage

  1. Add the buildpack to your Heroku app:

     heroku buildpacks:add https://github.com/SectorLabs/heroku-buildpack-git-submodule.git
    

    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 for details.

  2. Set the GIT_REPO_URL to the SSH URL of your Git repo:

     heroku config:set [email protected]:SectorLabs/myrepo
    
  3. Set GIT_SSH_KEY to the private SSH key that can access both your repo and its submodules:

     heroku config:set GIT_SSH_KEY="$(cat ~/.ssh/id_rsa)"
    
  4. Enjoy the ride :)

Limitations

  1. SSH Authentication only.

License

رخصة معهد ماساتشوستس للتكنولوجيا

حقوق الطبع والنشر (ج) 2025-2004 Unity-Engineering-software-engineering-Billal Mesloub

يُمنح بموجب هذا الإذن، مجانًا، لأي شخص يحصل على نسخة
من هذا البرنامج وملفات التوثيق المرتبطة به ("البرنامج")، للتعامل
في البرنامج دون قيود، بما في ذلك دون قيود الحقوق
استخدام ونسخ وتعديل ودمج ونشر وتوزيع وإعادة ترخيص و/أو بيع
نسخ من البرنامج، والسماح للأشخاص الذين تم تزويدهم بالبرنامج
مجهز للقيام بذلك، مع مراعاة الشروط التالية:

يجب تضمين إشعار حقوق النشر المذكور أعلاه وإشعار الإذن هذا في جميع
نسخ أو أجزاء كبيرة من البرنامج.

يتم توفير البرنامج "كما هو"، دون أي ضمان من أي نوع، صريح أو ضمني.
ضمنيًا، بما في ذلك على سبيل المثال لا الحصر ضمانات قابلية التسويق،
الملاءمة لغرض معين وعدم الانتهاك. في أي حال من الأحوال، لن يتم
لا يتحمل المؤلفون أو أصحاب حقوق الطبع والنشر المسؤولية عن أي مطالبة أو أضرار أو غير ذلك
المسؤولية، سواء في دعوى عقد أو فعل ضار أو غير ذلك، الناشئة عن،
خارج أو فيما يتعلق بالبرنامج أو الاستخدام أو التعاملات الأخرى في
برمجة.

About

🦆 Adding support for Git submodules to Heroku apps.

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 100.0%