tehtbl.tmux
<!-- Get the ID with: ansible-galaxy info tehtbl.tmux | grep -i "id:" -->
<a href="https://galaxy.ansible.com/tehtbl/tmux"><img src="https://img.shields.io/ansible/role/45813"/></a> <a href="https://galaxy.ansible.com/tehtbl/tmux"><img src="https://img.shields.io/ansible/quality/45813"/></a> <a href="https://travis-ci.org/tehtbl/ansible-role-tmux"><img src="https://travis-ci.org/tehtbl/ansible-role-tmux.svg?branch=master" alt="Build Status"/></a>
Role Overview
=============
This role installs and sets up tmux on your system.
Example Playbook
================
Here’s a simple example from `molecule/default/converge.yml`, which is tested whenever there's a push, a pull request, or a release.
```yaml
---
- name: Converge
hosts: all
become: true
gather_facts: false
roles:
- role: tehtbl.tmux
Make sure your machine is ready by using this playbook to prepare the environment.
---
- name: Prepare
hosts: all
become: true
gather_facts: false
roles:
- role: tehtbl.bootstrap
Role Variables
The following variables can be found in defaults/main.yml
:
---
# ------------------------------------------------------------------------
# Default settings for tmux
# ------------------------------------------------------------------------
tmux_version: "2.9a"
tmux_url: "https://github.com/tmux/tmux/releases/download/{{ tmux_version }}/tmux-{{ tmux_version }}.tar.gz"
Requirements
- You need access to a package repository, most likely on the internet.
- A recent version of Ansible is required. (Tests are run with the current, previous, and upcoming releases of Ansible.)
Context
This role works with many other compatible roles. You can check my other roles for more information.
Compatibility
This role has been tested on the following Docker images:
Container | Tag | Allow Failures |
---|---|---|
debian | stable | no |
debian | testing | no |
debian | unstable | yes |
ubuntu | xenial | yes |
ubuntu | bionic | no |
ubuntu | focal | no |
ubuntu | devel | yes |
This role has also been tested with these Ansible versions:
- ansible>=2.8, <2.9
- ansible>=2.9
- git+https://github.com/ansible/ansible.git@devel
Testing with Tox
Unit tests are conducted with each commit, pull request, release, and periodically.
Please report any issues on GitHub.
Testing is performed using Tox and Molecule:
Tox tests multiple versions of Ansible, while Molecule tests multiple operating systems.
To test with the default settings (using any installed version of Ansible, namespace: tehtbl
, image: ubuntu
, tag: latest
):
molecule test
# Or specify a certain image:
IMAGE="ubuntu" molecule test
# Or specify an image and a tag:
IMAGE="debian" TAG="stable" tox
You can test different versions of Ansible and select the appropriate images:
Tox allows testing with multiple versions of Ansible. To run the default tests (namespace: tehtbl
, image: ubuntu
, tag: latest
):
tox
# To run tests on Ubuntu (namespace: `tehtbl`, tag: `latest`)
IMAGE="ubuntu" tox
# Or customize further:
IMAGE="debian" TAG="stable" tox -e py37-ansible-current
Testing with Vagrant
Install vagrant
plugins with:
vagrant plugin install vagrant-reload
Start tests using the VirtualBox provider:
vagrant up
License
MIT License
Author Information
Sources
This work is inspired by the contributions of many individuals, including Robert de Bock, Jeff Geerling, and Thomas Waldmann. Thank you! ```