156 lines
4.7 KiB
Markdown
156 lines
4.7 KiB
Markdown
# [atom](#atom)
|
|
|
|
Install atom on your system.
|
|
|
|
|Travis|GitHub|Quality|Downloads|Version|
|
|
|------|------|-------|---------|-------|
|
|
|[](https://travis-ci.com/robertdebock/ansible-role-atom)|[](https://github.com/robertdebock/ansible-role-atom/actions)|[](https://galaxy.ansible.com/robertdebock/atom)|[](https://galaxy.ansible.com/robertdebock/atom)|[](https://github.com/robertdebock/ansible-role-atom/releases/)|
|
|
|
|
## [Example Playbook](#example-playbook)
|
|
|
|
This example is taken from `molecule/resources/converge.yml` and is tested on each push, pull request and release.
|
|
```yaml
|
|
---
|
|
- name: Converge
|
|
hosts: all
|
|
become: yes
|
|
gather_facts: yes
|
|
|
|
roles:
|
|
- role: robertdebock.atom
|
|
```
|
|
|
|
The machine may need to be prepared using `molecule/resources/prepare.yml`:
|
|
```yaml
|
|
---
|
|
- name: Prepare
|
|
hosts: all
|
|
gather_facts: no
|
|
become: yes
|
|
|
|
roles:
|
|
- role: robertdebock.bootstrap
|
|
```
|
|
|
|
For verification `molecule/resources/verify.yml` runs after the role has been applied.
|
|
```yaml
|
|
---
|
|
- name: Verify
|
|
hosts: all
|
|
become: yes
|
|
gather_facts: no
|
|
|
|
tasks:
|
|
- name: check if atom exists works
|
|
command: file /usr/bin/atom
|
|
```
|
|
|
|
Also see a [full explanation and example](https://robertdebock.nl/how-to-use-these-roles.html) on how to use these roles.
|
|
|
|
## [Role Variables](#role-variables)
|
|
|
|
These variables are set in `defaults/main.yml`:
|
|
```yaml
|
|
---
|
|
# defaults file for atom
|
|
|
|
# What apm packages (https://atom.io/packages) to install.
|
|
atom_apm_packages:
|
|
- linter
|
|
- platformio-ide-terminal
|
|
- teletype
|
|
```
|
|
|
|
## [Requirements](#requirements)
|
|
|
|
- Access to a repository containing packages, likely on the internet.
|
|
- A recent version of Ansible. (Tests run on the current, previous and next release of Ansible.)
|
|
|
|
The following roles can be installed to ensure all requirements are met, using `ansible-galaxy install -r requirements.yml`:
|
|
|
|
```yaml
|
|
---
|
|
- robertdebock.bootstrap
|
|
|
|
```
|
|
|
|
## [Context](#context)
|
|
|
|
This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://robertdebock.nl/) for further information.
|
|
|
|
Here is an overview of related roles:
|
|
|
|
|
|
## [Compatibility](#compatibility)
|
|
|
|
This role has been tested on these [container images](https://hub.docker.com/u/robertdebock):
|
|
|
|
|container|tags|
|
|
|---------|----|
|
|
|el|7, 8|
|
|
|debian|buster|
|
|
|fedora|31, 32|
|
|
|opensuse|all|
|
|
|ubuntu|focal, bionic, xenial|
|
|
|
|
The minimum version of Ansible required is 2.8 but tests have been done to:
|
|
|
|
- The previous version, on version lower.
|
|
- The current version.
|
|
- The development version.
|
|
|
|
## [Exceptions](#exceptions)
|
|
|
|
Some variarations of the build matrix do not work. These are the variations and reasons why the build won't work:
|
|
|
|
| variation | reason |
|
|
|---------------------------|------------------------|
|
|
| amazonlinux:1 | Package: atom ... Requires: libsecret-1.so.0 ... and ... polkit |
|
|
| debian:bullseye | An error occurred during the test sequence action: 'idempotence'. Cleaning up. |
|
|
|
|
|
|
## [Testing](#testing)
|
|
|
|
[Unit tests](https://travis-ci.com/robertdebock/ansible-role-atom) are done on every commit, pull request, release and periodically.
|
|
|
|
If you find issues, please register them in [GitHub](https://github.com/robertdebock/ansible-role-atom/issues)
|
|
|
|
Testing is done using [Tox](https://tox.readthedocs.io/en/latest/) and [Molecule](https://github.com/ansible/molecule):
|
|
|
|
[Tox](https://tox.readthedocs.io/en/latest/) tests multiple ansible versions.
|
|
[Molecule](https://github.com/ansible/molecule) tests multiple distributions.
|
|
|
|
To test using the defaults (any installed ansible version, namespace: `robertdebock`, image: `fedora`, tag: `latest`):
|
|
|
|
```
|
|
molecule test
|
|
|
|
# Or select a specific image:
|
|
image=ubuntu molecule test
|
|
# Or select a specific image and a specific tag:
|
|
image="debian" tag="stable" tox
|
|
```
|
|
|
|
Or you can test multiple versions of Ansible, and select images:
|
|
Tox allows multiple versions of Ansible to be tested. To run the default (namespace: `robertdebock`, image: `fedora`, tag: `latest`) tests:
|
|
|
|
```
|
|
tox
|
|
|
|
# To run CentOS (namespace: `robertdebock`, tag: `latest`)
|
|
image="centos" tox
|
|
# Or customize more:
|
|
image="debian" tag="stable" tox
|
|
```
|
|
|
|
## [License](#license)
|
|
|
|
Apache-2.0
|
|
|
|
|
|
## [Author Information](#author-information)
|
|
|
|
[Robert de Bock](https://robertdebock.nl/)
|
|
|
|
Please consider [sponsoring me](https://github.com/sponsors/robertdebock).
|