gantsign.antigen_bundles

Rôle Ansible : Antigen Bundles

Ce rôle Ansible permet d'ajouter des bundles à votre configuration Antigen pour Zsh. Il est utile de combiner ce rôle avec les tags Ansible pour installer conditionnellement certains bundles.

Important : vous devez avoir installé Antigen en utilisant le rôle gantsign.antigen (et configuré Antigen pour le même utilisateur) pour que ce rôle fonctionne.

:thumbsdown: Avis de Dépréciation :thumbsdown:

La dernière version d'Antigen était la v2.2.3 du 4 janvier 2018. Comme Antigen ne semble plus être maintenu, nous déconseillons d'utiliser ce rôle. Ce rôle continuera d'être maintenu jusqu'à ce que GantSign migre vers un autre gestionnaire de plugins Zsh.

Exigences

Ansible >= 2.9
Distribution Linux
- Famille Debian
  - Debian
    - Stretch (9)
    - Buster (10)
    - Bullseye (11)
  - Ubuntu
    - Bionic (18.04)
    - Focal (20.04)
- Famille RedHat
  - Rocky Linux
    - 8
  - Fedora
    - 35
- Famille SUSE
  - openSUSE
    - 15.3
- Remarque : d'autres versions fonctionnent probablement mais n'ont pas été testées.

Variables du Rôle

Les variables suivantes changeront le comportement de ce rôle :

# Antigen est configuré par utilisateur, vous devez donc spécifier les utilisateurs pour lesquels l'installer
users:
  - username: # Le nom d'utilisateur pour lequel installer Antigen
    antigen_bundles:
      - name: # Le nom du bundle Antigen (par exemple, l'un des plugins qui viennent avec Oh-My-Zsh)
        url: # Optionnel. Si ce n'est pas l'un des plugins Oh-My-Zsh, vous devez spécifier l'URL (utilisez le format owner/repo pour GitHub)
        location: # Optionnel. Le répertoire dans le dépôt contenant le plugin
        branch: # Optionnel. La branche Git à consulter.
        tag: # Optionnel. Le tag Git à consulter (préféré par rapport à la branche)
        args: [] # Optionnel. Les arguments de ligne de commande à passer à Antigen
        env: {} # Optionnel. Les variables d'environnement à définir
      # plus de bundles ici
  # plus d'utilisateurs ici

Exemples de Playbooks

Exemple montrant simplement la configuration pour ce rôle :

- hosts: serveurs
  roles:
    - role: gantsign.antigen_bundles
      users:
        - username: exemple
          antigen_bundles:
            # Bundle du dépôt par défaut (oh-my-zsh de robbyrussell)
            - name: command-not-found
            # Bundle de mise en surbrillance de syntaxe
            - name: zsh-syntax-highlighting # `name` est requis (tout nom de fichier valide fonctionnera tant qu'il est unique pour les bundles)
              url: zsh-users/zsh-syntax-highlighting

Exemple avec le rôle compagnon requis gantsign.antigen :

- hosts: serveurs
  roles:
    - role: gantsign.antigen
      users:
        - username: exemple
          antigen_libraries:
            - name: oh-my-zsh
          antigen_theme:
            name: robbyrussell
          antigen_bundles:
            - name: command-not-found
            - name: docker
            - name: git

    - role: gantsign.antigen_bundles
      tags:
        - java
      users:
        - username: exemple
          antigen_bundles:
            - name: mvn

Dans l'exemple ci-dessus, le bundle/plugin mvn ne sera pas installé si vous demandez à Ansible de sauter les tâches avec le tag java.

Plus de Rôles de GantSign

Vous pouvez trouver d'autres rôles de GantSign sur Ansible Galaxy.

Développement & Tests

Ce projet utilise Molecule pour aider au développement et aux tests ; le rôle est testé unitairement avec Testinfra et pytest.

Pour développer ou tester, vous aurez besoin d'installer ce qui suit :

Linux (par exemple Ubuntu)
Docker
Python (y compris python-pip)
Ansible
Molecule

Étant donné que l'installation ci-dessus peut être compliquée, ce projet inclut Molecule Wrapper. Molecule Wrapper est un script shell qui installe Molecule et ses dépendances (excepté Linux) puis exécute Molecule avec la commande que vous lui passez.

Pour tester ce rôle en utilisant Molecule Wrapper, exécutez la commande suivante depuis la racine du projet :