Skip to content

Latest commit

 

History

History
47 lines (26 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

47 lines (26 loc) · 1.46 KB
Raw

Requirements

The following instructions assume pipenv is installed. On Debian 11 run :

sudo apt install pipenv

Prepare development environment

This project needs Ansible and Ansible-lint. The best and easiest way to install those dependencies is to use the provided scripts :

bin/setenv

In order to get the currently installed versions :

bin/versions

Run linting

Linting is performed at repository level using Ansible-lint (it runs transparently YAMLlint) :

cd <repository>
ansible-lint

Encrypting variables

Encrypting a file:

Encrypting a variable:

ansible-vault encrypt_string --ask-vault-pass --stdin-name '<variable>'

Generating a random encrypted variable

openssl rand -base64 48 | ansible-vault encrypt_string --ask-vault-pass --stdin-name '<variable>'

Verifying an encrypted variable:

ansible --ask-vault-pass -i <inventory> <host> -m debug -a 'var=<variable>'

More information is available in the ansible-vault documentation on https://docs.ansible.com/ansible/latest/cli/ansible-vault.html.

Continuous integration

The GitHub Action workflow CI is executed for each commit, on merge request (targeting the main branch) and at least once a week on saturday morning. This workflow runs linting with YAMLlint and Ansible-lint.