Submoduły na github.com

Submoduły

Submoduły, czyli co zrobić, żeby np. na githubie w jednym repo umieścić inne repozytoria, aby wyglądało to tak jak poniżej, a nie tak jak na przykład tutaj.


Do czego się w ogóle przydają submoduły i dlaczego powinieneś je stosować? Wyobraź sobie, że tworzysz swoje repozytorium, które do poprawnej pracy wymaga innych, konkretnych repozytoriów gita. I tutaj z pomocą przychodzą submoduły. Dzięki nim twoje repozytorium będzie posiadało informacje o tym, gdzie dany submoduł się znajduje (jego adres) oraz jego ostatnie commit ID.

Dzięki takiemu zabiegowi, inni developerzy, którzy sklonują twoje repo (które wykorzystuje inne repozytoria), nie będą musieli się martwić, czy wszystko będzie działało tak jak powinno. Unikniesz przez to czasami dziwnych błędów. Np. ktoś dociągnie zbyt stare repozytorium lub zbyt nowe, albo całkowicie inną gałąź, niż tą które wykorzystuje twoje repo ;)

Osobiście póki co, użyłem submodułów w moim repo dotfiles.

Dodawanie submodułów

Załóżmy, że chcesz dodać jako submoduł repozytorium hubble, wystarczy wykonać komendę:
git submodule add https://github.com/jaymedavis/hubble.git
I to tyle, jeśli chodzi o dodawanie submodułów.

Klonowanie repozytorium z submodułami

Powiedzmy, że chcesz sklonować moje repozytorium ;) dotfiles, które posiada kilka submodułów. Repo klonujesz normalnie, jak każde inne. Po sklonowaniu jednak submoduły są puste, nic w nich nie ma, nie panikuj! Wystarczy wpisać dwie poniższe komendy:
git submodule init
git submodule update
W ten sposób git dociągnie wszystkie wymagane submoduły. Jeżeli autor repozytorium, które sklonowałeś, ustawił, że dany submoduł ma być w danej wersji, git sobie z tym poradzi i dociągnie dokładnie tą wersję. Jeżeli autor nie użył by submodułów mógłbyś mieć problem, bo skąd masz wiedzieć, jaką wersję danego repo masz sklonować?

Usuwanie submodułów

Z usuwaniem może być czasami trochę problemów. Najlepiej jest to zrobić w ten sposób:
  1. Usuwasz odpowiednią sekcję z pliku .gitmodules oraz .git/config
  2. Wykonujesz komendę git rm --cached ścieżka_do_submodułu (bez ukośników)
  3. Commitujesz i usuwasz nieśledzony już moduł
I to tyle ile wystarczy wiedzieć o submodułach na początek. Więcej informacji znajdziesz w dokumentacji.

Comments

Post a Comment

Popular posts from this blog

GitLab - extends keyword

Image
In the previous post I had written about the include keyword. Now, let's dive in the extends  keyword. What can you do with this? Here is the definition from GitLab documentation: extends defines entry names that a job that uses extends inherits from. It’s an alternative to using YAML anchors and is a little more flexible and readable. So, when is it useful? It is useful when you want to be DRY and keep your setup cleanly. Let's assume that you want to build a docker image and give developers possibility to deploy the image on dev , staging and prod environments. We are going to do that without the extends keyword, and after that we will think how we can do it better. Example without the extends  keyword: As you can see, there is a lot of code which repeats itself: stage, image, when  and script . We can remove a lot of code! So, let's do that. We are going to create a hidden job .deploy  (you will not see this job in a pipeline) and the rest of the jobs will in
Read more

GitLab - trigger keyword

Image
 We are going to talk about the trigger keyword today. With this feature you can define a downstream pipeline trigger. So, you can trigger a pipeline in any project (you must have access to this project of course). There are two types of downstream pipelines: multi-project pipelines child pipelines  Let's omit child pipelines and have a look at multi-project pipelines. It is very easy to use. You just need to provide a path to the project and that's it. Remember that you only can trigger a pipeline, not a job ! You can also provide more information like environment variables. As always, I am going to provide some examples, so you will understand it better. The first example: you want to trigger a pipeline in another project after the deployment of your service/s. How to do that? Here we want to trigger this pipeline (project my/run-tests ). Let's say that we want to run some tests after each deployment: We need to add the job which will trigger this pipeline in my/run-
Read more

Managing Secrets in GitLab / Git

Image
Let's say that you have to log in via ssh into an instance, and you work with GitLab, so you want to keep the private key in GitLab somewhere. Is it secure? Let's see! Custom environment variables You can use custom environment variables. Here you can read more about them (Developers cannot change them, only Maintainers and Owners can). There are two types of variables: Variable (the runner creates an environment variable that uses the key for the name and the value for the value) File (the runner creates an environment variable that uses the key for the name. For the value, the runner writes the variable value to a temporary file and uses this path) It seems that we can use File type for our purpose. We can set up it via API or UI . So, let's do that! Go to project's Settings > CI/CD . There will be Variables section (btw, you can specify variables also per group and even for all projects (in admin panel)). Click Add Variable button and add a variable: Key:
Read more