Enable several git instances in profile, and enable git profiles selection in services

[odysseu]

Hi,

It would be useful and great to enable different git profiles in Onyxia, so in my service I enable either a specific account, or several (what do you think of this second option ?).

Indeed, sometime my work gets from github, sometimes from gitlab, sometimes it can come from elsewhere (BitBucket, sourceforge, ...).

For exemple in the profile:

And then in the service, enable to chose between 0 and several git credentials.

Thanks for considering, keep up the god work !

[ddecrulle]

Hey Ulysse,

How are you doing? 🙂

Thanks for the suggestion! I think there might be a small mix-up between Git itself and Git instances like GitHub, GitLab, or Bitbucket. In practice, the Git configuration (name, email, SSH keys, etc.) can usually be reused across different providers.

So while it would technically be possible to manage multiple separate Git profiles, it’s probably not the most efficient approach, using a shared configuration for all providers tends to be simpler and works just as well.

That said, your use case makes sense especially if you often switch between different identities or organizations.

Catch you later,
Dylan

[odysseu]

Doin' good out here, thx ! 😃

Indeed, I meant enabling credentials from multiple git configurations that match git instances.

In practice, this issue points that today one can't fastly or easily use the git ... commands from or to different git instances (github, gitlab.com, ...) without manually setting one's git configurations on the service.

By making the git configurations plural, we could add zero, one or more git credentials in a service.

[ddecrulle]

Technically, we could allow multiple credentials, but there should still be only one Git configuration (name, email, etc.). Btw, it could lead to commits being pushed with the wrong author information.

So for now, I think it makes more sense to keep a single Git configuration and token per service.

That said, we’re keeping your suggestion in mind

[odysseu]

Yes, it could lead to mistakes without precaution, however, by looking quickly at it, there are ways :

• When using SSH :

  See details

  - Have Onyxia place the SSH keys in the container, typically in `~/.ssh/` (e.g., `id_rsa_github`, `id_rsa_gitlab`). - Configure the SSH Config file `~/.ssh/config` to specify which key to use for which host or repository:

  Host exemple_01
      HostName github.com
      User git
      IdentityFile ~/.ssh/id_rsa_github
      IdentitiesOnly yes
  
  Host exemple_02
      HostName gitlab.com
      User git
      IdentityFile ~/.ssh/id_rsa_gitlab
      IdentitiesOnly yes
  

  • When running Git commands, the user will need to use the appropriate host alias:

  git clone git@exemple_01:user/repo.git
  git clone git@exemple_02:org/repo.git
  

• When using HTTPS, two possibilities :

  Manually precise which credentials to use for every git command (not my personnal best) :

  Using https://git-scm.com/docs/git-credential-store or https://git-scm.com/docs/git-credential-cache to store credentials.

  Then, only once :

  git remote add personal https://github.com/user/repo.git
  git remote add work https://github.com/org/repo.git

  and then for exemple :

  git push personal main
  git push work main

  Automatically have onyxia set up the different credentials using the `includeif` git option (seems the best to me)

  Follow [this guide from 2023](https://www.conciergerie.dev/blog/git-configuration-comment-passer-dun-contexte-utilisateur-a-un-autre-avec-includeif):

  set up .gitconfig as usual with this:

  [user]
      name = default_name                              # or name_01
      email = something_default@domaine_default.com    # or something_01@domaine_01.com
      username = usersnema_default                     # or username_01
  [diff]
      tool = vimdiff
  [includeIf "gitdir:~/workspaces/domaine_01/"]
      path = ~/.gitconfig-personnaldomaine_01
  [includeIf "gitdir:~/workspaces/domaine_02/"]
      path = ~/.gitconfig-personnaldomaine_02

  Then in the .gitconfig-personnaldomaine_01 :

  [user]
      name = name_01
      email = something_01@domaine_01.com
      username = username_01
  [credential]
      helper = store --file=~/.git-credentials-personnaldomaine_01

  and in the .gitconfig-personnaldomaine_02:

  [user]
      name = name_02
      email = something_02@domain_02.com
      username = username_02
  [credential]
      helper = store --file=~/.git-credentials-personnaldomaine_02

  Then have Onyxia put the credentials in the .git-credentials-personnaldomaine_01 and the .git-credentials-personnaldomaine_01, files; which will be secured using :

  chmod 600 ~/.git-credentials-personnaldomaine_01
  chmod 600 ~/.git-credentials-personnaldomaine_02