Add a git_repo role

[wbclark]

This role uses a single ansible data structure to manage a set of git repositories with potentially multiple remotes and multiple branches per remote.

[wbclark]

Not yet properly tested, due to difficulty getting #1579 to play nicely with 5683c94

[wbclark]

I added a README for this role explaining how it is used, and marked it ready for review

[ianballou]

I haven't tested this entire thing, but it has been in use with our hotfixing process for over a year now and has been working well.

[wbclark]

@evgeni @ehelms this is a basic role that we've been making wide use of in our hotfix building process. I've been using it also in my devel box, and generally anywhere that I need to set up some repositories with multiple remotes and branches and optionally do a basic bundle install or pip install (for repositories like tool belt, rpm packaging, pulpcore packaging, etc). It provides a simple interface that makes this all this very easy to manage and maintain in yaml (like updating the tracked release branches for various repositories being hotfixed).

Do you have some time this week to take a look?

[wbclark]

Changes I've force pushed at https://github.com/wbclark/forklift/tree/git_repo_role actually aren't reflected here. I may need to re-open the PR.

EDIT: Nevermind, it took several minutes but it did eventually update.

[wbclark]

I've tried to use the git_config module for this sort of thing, which was suggested by the maintainers of the git module as that module doesn't support everything that we need to do here, but branch creation was the one area where I could never make git_config work.

Doing it with the command module smells somewhat hacky, but it's not only worked very reliably, it also ends up being quite a bit simpler.

[ianballou]

This is looking good to me! How I tested:

[ian@manicotto forklift]$ cat playbooks/repositories_test.yml
---
- hosts: all
  tasks:
    - name: "Setup git repositories"
      ansible.builtin.include_role:
        name: git_repo
      loop: "{{ git_repositories }}"
      loop_control:
        loop_var: repo
      vars:
        git_repo_repository: "{{ repo }}"

  fedora39:
    box_name: 'fedora/39-cloud-base'
    pty: true
    ansible:
      playbook: 'playbooks/repositories_test.yml'
      variables:
        git_repositories:
          - name: 'foreman'
            dir: '/home/vagrant'
            remotes:
              - name: 'origin'
                url: 'https://github.com/theforeman/foreman.git'
                branches:
                  - 'develop'
          - name: 'katello'
            dir: '/home/vagrant'
            remotes:
              - name: 'origin'
                url: 'https://github.com/Katello/katello.git'
                branches:
                  - 'master'
            python_packages:
              - 'ansible'
              - 'obal'
              - 'tito'

Only snag I hit was that git wasn't on my box. Should a role be responsible for ensuring certain dependencies are installed? I'm not sure if that's a usual Ansible expectation.

[ianballou]

(For future reference, I took that playbook from here: wbclark@bb6de0d)

[wbclark]

Only snag I hit was that git wasn't on my box. Should a role be responsible for ensuring certain dependencies are installed? I'm not sure if that's a usual Ansible expectation.

Good idea. I've added meta/main.yml with a dependency for the existing git role.

[ianballou]

Looks good to me! In the future we can revamp the git role to use the generic package action so that other distros are supported.

[evgeni]

As said on Matrix: I think it's too complicated, but I don't mind having it if it's useful for y'all

Mergin.