Skip to content

manala/ansible-path

Repository files navigation

Ansible Collection - manala.path

homepage

The flexible, robust, and web oriented toolbox for Ansible !

Tests

Using this collection

Installing the Collection from Ansible Galaxy

Before using this collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install manala.path

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: manala.path

Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the ansible package. To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install manala.path --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 1.1.0:

ansible-galaxy collection install manala.path:==1.1.0

Installing the Collection from Github

In case of unavailability of ansible-galaxy, we host a tar.gz of every version of our collection on github:

  • Check latest version available here
  • Use your prefered method:
    • cli:
      ansible-galaxy collection install https://github.com/manala/ansible-path/releases/download/$VERSION/manala-path-$VERSION.tar.gz
    • requirements.yaml:
      collections:
        - name: https://github.com/manala/ansible-path/releases/download/$VERSION/manala-path-$VERSION.tar.gz
          type: url

See Ansible Using collections for more details.

Use this collection

See the examples.

Release notes

See the changelog.

Contributing to this collection

Found a bug ? Please open an issue

You can contact us here

Any kind of contribution is very welcome, you can submit pull requests here

This collection uses ansible-lint, and ansible-test for linting and testing roles.

Open a docker shell

make sh

Launch sanity tests (first time with --requirements)

ansible-test sanity --python 3.11 --requirements
ansible-test sanity --python 3.11

Launch units tests (first time with --requirements) over a specific file or not

ansible-test units --python 3.11 --requirements
ansible-test units --python 3.11
ansible-test units --python 3.11 tests/unit/plugins/lookup/test_foo.py

Licensing

This collection is distributed under the MIT license.

See LICENSE to see the full text.

Author information

Manala (https://www.manala.io/)