Add explicit Jinja2 requirement (#382)

Explicitly list Jinja2 `2.11.3` as a requirement, as well as detail the minimum supported version (`2.11.x`).
This commit is contained in:
Alessandro Fael Garcia 2021-03-24 19:17:15 +01:00 committed by GitHub
parent 7f04ec6b85
commit 20a910e754
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 11 deletions

View File

@ -1,4 +1,5 @@
ansible-base==2.10.7 ansible-base==2.10.7
jinja2==2.11.3
ansible-lint==5.0.5 ansible-lint==5.0.5
yamllint==1.26.0 yamllint==1.26.0
molecule[docker]==3.3.0 molecule[docker]==3.3.0

View File

@ -5,14 +5,15 @@
FEATURES: FEATURES:
* Replace Ansible community distribution with Ansible base and add the necessary extra collections as a dependency requirement. For reference, these are: * Replace Ansible community distribution with Ansible base and add the necessary extra collections as a dependency requirement. For reference, these are:
```yaml ```yaml
--- ---
collections: collections:
- name: community.general - name: community.general
version: 2.3.0 version: 2.3.0
- name: ansible.posix - name: ansible.posix
version: 1.2.0 version: 1.2.0
``` ```
* Explicitly list Jinja2 `2.11.3` as a requirement, as well as detail the minimum supported version (`2.11.x`).
* Add support for Dependabot. * Add support for Dependabot.
ENHANCEMENTS: ENHANCEMENTS:

View File

@ -21,7 +21,8 @@ With the advent of Ansible collections and the release of the [NGINX Core Ansibl
### Ansible ### Ansible
* This role is developed and tested with [maintained](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html) versions of Ansible base. When using Ansible base, you will also need to install the following collections: * This role is developed and tested with [maintained](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html) versions of Ansible base (bigger than `2.10`) and Ansible (bigger than `2.9.10`).
* When using Ansible base, you will also need to install the following collections:
```yaml ```yaml
--- ---
collections: collections:
@ -30,12 +31,17 @@ With the advent of Ansible collections and the release of the [NGINX Core Ansibl
- name: ansible.posix - name: ansible.posix
version: 1.2.0 version: 1.2.0
``` ```
**Note:** You can alternatively install the Ansible community distribution if you don't want to manage individual collections. **Note:** You can alternatively install the Ansible community distribution (what is known as the "old" Ansible) if you don't want to manage individual collections.
* Instructions on how to install Ansible can be found in the [Ansible website](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#upgrading-ansible-from-version-2-9-and-older-to-version-2-10-or-later). * Instructions on how to install Ansible can be found in the [Ansible website](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#upgrading-ansible-from-version-2-9-and-older-to-version-2-10-or-later).
### Jinja2
* This role uses Jinja2 templates. Ansible base installs Jinja2 by default, but depending on your install and/or upgrade path, you might be running an outdated version of Jinja2. The minimum version of Jinja2 required for the role to properly function is `2.11`.
* Instructions on how to install Jinja2 can be found in the [Jinja2 website](https://jinja.palletsprojects.com/en/2.11.x/intro/#installation).
### Molecule ### Molecule
* Molecule `3.x` is used to test the various functionalities of the role. * Molecule is used to test the various functionalities of the role. The recommended version of Molecule to test this role is `3.3`.
* Instructions on how to install Molecule can be found in the [Molecule website](https://molecule.readthedocs.io/en/latest/installation.html). * Instructions on how to install Molecule can be found in the [Molecule website](https://molecule.readthedocs.io/en/latest/installation.html).
## Installation ## Installation