Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gantsign/ansible_role_antigen
Ansible role for installing the Antigen and using it to configure Zsh
https://github.com/gantsign/ansible_role_antigen
ansible ansible-role antigen oh-my-zsh zsh
Last synced: 2 months ago
JSON representation
Ansible role for installing the Antigen and using it to configure Zsh
- Host: GitHub
- URL: https://github.com/gantsign/ansible_role_antigen
- Owner: gantsign
- License: mit
- Created: 2018-08-04T09:03:03.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-28T19:45:18.000Z (over 2 years ago)
- Last Synced: 2024-08-02T12:49:59.387Z (5 months ago)
- Topics: ansible, ansible-role, antigen, oh-my-zsh, zsh
- Language: Shell
- Homepage: https://galaxy.ansible.com/gantsign/antigen
- Size: 105 KB
- Stars: 27
- Watchers: 3
- Forks: 16
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - gantsign/ansible_role_antigen - Ansible role for installing the Antigen and using it to configure Zsh (ansible)
README
Ansible Role: Antigen
=====================
[](https://github.com/gantsign/ansible_role_antigen/actions?query=workflow%3ATests)
[](https://galaxy.ansible.com/gantsign/antigen)
[](https://raw.githubusercontent.com/gantsign/ansible_role_antigen/master/LICENSE)
Role to install the [Antigen](http://antigen.sharats.me/) plugin manger for Zsh
and use it to configure Zsh.
This role has a companion role that enables you to conditionally install
particular Antigen bundles. You can find details of that role at
[gantsign.antigen_budles](https://galaxy.ansible.com/gantsign/antigen_bundles).
:thumbsdown: Deprecation Notice :thumbsdown:
--------------------------------------------
The last Antigen release was
[v2.2.3](https://github.com/zsh-users/antigen/releases/tag/v2.2.3) on 4 Jan
2018. This role actually uses
[v2.0.2](https://github.com/zsh-users/antigen/releases/tag/v2.0.2) (22 Apr 2017)
due to issues with later versions and some Oh My Zsh plugins. Since Antigen
appears to no longer be maintained, we recommend against using this role. This
role will continue to be maintained until such time as GantSign migrates to a
different Zsh plugin manager.
Requirements
------------
* Ansible >= 2.9
* Linux Distribution
* Debian Family
* Debian
* Stretch (9)
* Buster (10)
* Bullseye (11)
* Ubuntu
* Bionic (18.04)
* Focal (20.04)
* RedHat Family
* Rocky Linux
* 8
* Fedora
* 35
* SUSE Family
* openSUSE
* 15.3
* Note: other versions are likely to work but have not been tested.
Role Variables
--------------
The following variables will change the behavior of this role:
```yaml
# Antigen version number
antigen_version: '2.0.2'
# SHA256 sum for the redistributable package
antigen_redis_sha256sum: 'f47ec933b32c578abe8cb39b24e0ddd114ef5cc01b3c05bcb634859ead31493f'
# Should Oh-My-Zsh be installed with Antigen (doesn't call `antigen use`)
antigen_install_oh_my_zsh: yes
# Mirror location for Antigen download
antigen_redis_mirror: 'https://github.com/zsh-users/antigen/releases/download/v{{ antigen_version }}'
# Directory to store files downloaded for Antigen installation on the remote box
antigen_download_dir: "{{ x_ansible_download_dir | default(ansible_env.HOME + '/.ansible/tmp/downloads') }}"
# Antigen is installed per user so you need to specify the users to install it for
users:
- username: # The username of the user to install Antigen for
antigen_libraries:
- name: # The name of the library (e.g. oh-my-zsh or prezto) must be unique
url: # Optional. If you're using a custom library you must specify the Git URL
args: # Optional. Command line arguments to pass to Antigen
- '--exampleParam1'
- 'paramValue1' # example with value passed as a separate arg
- '--exampleParam2=paramValue2' # example with value passed in the same arg
env: # Optional. Environnement variables to set
EXAMPLE_ENV1: 'envValue1'
EXAMPLE_ENV2: '"${HOME}/.example"' # the single quotes are for YAML the double quotes are for the shell
# more libraries here
antigen_theme:
name: # The name of the library (e.g. one of the themes that come with Oh-My-Zsh)
url: # Optional. If the theme doesn't come with Oh-My-Zsh you must specify the Git URL
env: {} # Optional. Environnement variables to set
antigen_bundles:
- name: # The name of the Antigen bundle (e.g. one of the plugins that come with Oh-My-Zsh)
url: # Optional. If the it's not one of the Oh-My-Zsh plugins you must specify the URL (use owner/repo shorthand for GitHub)
location: # Optional. The directory in the repository containing the plugin
branch: # Optional. Git branch to checkout.
tag: # Optional. Git tag to checkout (takes preference over branch)
args: [] # Optional. Command line arguments to pass to Antigen
env: {} # Optional. Environnement variables to set
# more bundles here
# more users here
```
Example Playbooks
-----------------
The following achieves the same as the example in the Antigen
[README.mkd](https://github.com/zsh-users/antigen/blob/develop/README.mkd#usage).
```yaml
- hosts: servers
roles:
- role: gantsign.antigen
users:
- username: example
antigen_libraries:
- name: oh-my-zsh
antigen_theme:
name: robbyrussell
antigen_bundles:
# Bundles from the default repo (robbyrussell's oh-my-zsh).
- name: git
- name: heroku
- name: pip
- name: lein
- name: command-not-found
# Syntax highlighting bundle.
- name: zsh-syntax-highlighting # `name` is required (any valid file name will do so long as it's unique for the bundles)
url: zsh-users/zsh-syntax-highlighting
```
The following achieves the same as the example in the `gantsign.oh-my-zsh` role
[README.md](https://github.com/gantsign/ansible-role-oh-my-zsh/blob/master/README.md#example-playbook)
```yaml
- hosts: servers
roles:
- role: gantsign.antigen
users:
- username: example
antigen_libraries:
- name: oh-my-zsh
env:
DISABLE_AUTO_UPDATE: '"true"' # Optional (this was hard-coded in the .zshrc of the `gantsign.oh-my-zsh` role)
antigen_theme:
name: robbyrussell # This role has no default theme (unlike the `gantsign.oh-my-zsh` role)
antigen_bundles:
- name: git # This role has no default bundles/plugins (unlike the `gantsign.oh-my-zsh` role)
```
More Roles From GantSign
------------------------
You can find more roles from GantSign on
[Ansible Galaxy](https://galaxy.ansible.com/gantsign).
Development & Testing
---------------------
This project uses [Molecule](http://molecule.readthedocs.io/) to aid in the
development and testing; the role is unit tested using
[Testinfra](http://testinfra.readthedocs.io/) and
[pytest](http://docs.pytest.org/).
To develop or test you'll need to have installed the following:
* Linux (e.g. [Ubuntu](http://www.ubuntu.com/))
* [Docker](https://www.docker.com/)
* [Python](https://www.python.org/) (including python-pip)
* [Ansible](https://www.ansible.com/)
* [Molecule](http://molecule.readthedocs.io/)
Because the above can be tricky to install, this project includes
[Molecule Wrapper](https://github.com/gantsign/molecule-wrapper). Molecule
Wrapper is a shell script that installs Molecule and it's dependencies (apart
from Linux) and then executes Molecule with the command you pass it.
To test this role using Molecule Wrapper run the following command from the
project root:
```bash
./moleculew test
```
Note: some of the dependencies need `sudo` permission to install.
License
-------
MIT
Author Information
------------------
John Freeman
GantSign Ltd.
Company No. 06109112 (registered in England)