gantsign.antigen_bundles

Ansible Role: Antigen Bundles

This Ansible role helps you add bundles to your Antigen setup for Zsh. You can use it together with Ansible tags to choose which bundles to install based on your needs.

Note: Make sure you have already installed Antigen using the gantsign.antigen role and configured it for the same user before using this role.

:thumbsdown: Important: This Role is No Longer Actively Maintained :thumbsdown:

The latest version of Antigen is v2.2.3, released on January 4, 2018. Since Antigen is no longer maintained, we suggest not using this role. This role will still be maintained until GantSign moves to a different Zsh plugin manager.

Requirements

Ansible version 2.9 or higher
Supported Linux Distributions:
- Debian:
  - Stretch (9)
  - Buster (10)
  - Bullseye (11)
- Ubuntu:
  - Bionic (18.04)
  - Focal (20.04)
- RedHat:
  - Rocky Linux 8
  - Fedora 35
- SUSE:
  - openSUSE 15.3
- Note: Other versions may work but haven't been tested.

Role Variables

You can customize this role using the following variables:

# You need to specify users for whom Antigen will be installed
users:
  - username: # User for which to install Antigen
    antigen_bundles:
      - name: # Name of the Antigen bundle (e.g., a plugin from Oh-My-Zsh)
        url: # Optional. Must be specified if it is not one of the Oh-My-Zsh plugins (use owner/repo format for GitHub)
        location: # Optional. The directory containing the plugin in the repository
        branch: # Optional. Git branch to checkout
        tag: # Optional. Git tag to checkout (takes priority over branch)
        args: [] # Optional. Command line arguments for Antigen
        env: {} # Optional. Environment variables to set
      # Additional bundles can be added here
  # Additional users can also be added here

Example Playbooks

Here is an example showing the setup for this role:

- hosts: servers
  roles:
    - role: gantsign.antigen_bundles
      users:
        - username: example
          antigen_bundles:
            # A bundle from the default repo (Oh-My-Zsh)
            - name: command-not-found
            # Syntax highlighting bundle
            - name: zsh-syntax-highlighting # `name` is required (any valid unique file name will work)
              url: zsh-users/zsh-syntax-highlighting

Example including the required companion gantsign.antigen role:

- hosts: servers
  roles:
    - role: gantsign.antigen
      users:
        - username: example
          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: example
          antigen_bundles:
            - name: mvn

In this example, the mvn bundle/plugin will not be installed if you skip tasks with the java tag.

More Roles from GantSign

You can find additional roles from GantSign on Ansible Galaxy.

Development & Testing

This project uses Molecule for development and testing. Unit tests are done with Testinfra and pytest.

To develop or test this role, you need:

Linux (e.g., Ubuntu)
Docker
Python (including python-pip)
Ansible
Molecule

Installing these can be tricky, so this project includes Molecule Wrapper. The Molecule Wrapper is a shell script that installs Molecule and its dependencies (excluding Linux) and then runs Molecule with the command you provide.

To test this role with Molecule Wrapper, run the following command from the project root: