From f23a50f7430c5fad388562f86202a6bc5ee489e1 Mon Sep 17 00:00:00 2001 From: alessfg Date: Wed, 24 Mar 2021 14:41:52 +0100 Subject: [PATCH 1/5] Add explicit Jinja2 requirement --- .github/workflows/requirements/requirements_molecule.txt | 1 + README.md | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/.github/workflows/requirements/requirements_molecule.txt b/.github/workflows/requirements/requirements_molecule.txt index 776322217..67cb6390b 100644 --- a/.github/workflows/requirements/requirements_molecule.txt +++ b/.github/workflows/requirements/requirements_molecule.txt @@ -1,4 +1,5 @@ ansible-base==2.10.7 +jinja2==2.11.3 ansible-lint==5.0.4 yamllint==1.26.0 molecule[docker]==3.2.4 diff --git a/README.md b/README.md index fea320fac..ffe431324 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,10 @@ With the advent of Ansible collections and the release of the [NGINX Core Ansibl **Note:** You can alternatively install the Ansible community distribution 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). +### 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 required version of Jinja2 in this role 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 `3.x` is used to test the various functionalities of the role. From 7e7b904a411fd73f0f7e826dbf7c17fcee895946 Mon Sep 17 00:00:00 2001 From: alessfg Date: Wed, 24 Mar 2021 14:42:44 +0100 Subject: [PATCH 2/5] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index bec5c3ae7..c76ba524d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ FEATURES: * Replace Ansible community distribution with Ansible base and add the necessary extra collections as a dependency requirement. For reference, these are: * `community.general` * `ansible.posix` +* Explicitly list Jinja2 as a requirement, as well as detail the minimum supported version. * Add support for Dependabot. ENHANCEMENTS: From 9d529f6098bda6ca8583386f305fd036b9e5524e Mon Sep 17 00:00:00 2001 From: alessfg Date: Wed, 24 Mar 2021 14:43:28 +0100 Subject: [PATCH 3/5] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c76ba524d..4fc6091f0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,7 +7,7 @@ FEATURES: * Replace Ansible community distribution with Ansible base and add the necessary extra collections as a dependency requirement. For reference, these are: * `community.general` * `ansible.posix` -* Explicitly list Jinja2 as a requirement, as well as detail the minimum supported version. +* Explicitly list Jinja2 `2.11.3` as a requirement, as well as detail the minimum supported version (`2.11.x`). * Add support for Dependabot. ENHANCEMENTS: From 866c2bb32568ab69b8984a568e8742dd5f9dd1a4 Mon Sep 17 00:00:00 2001 From: alessfg Date: Wed, 24 Mar 2021 17:24:30 +0100 Subject: [PATCH 4/5] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ffe431324..5a9f54be9 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,8 @@ With the advent of Ansible collections and the release of the [NGINX Core Ansibl ### 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 required version of Jinja2 in this role 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). +* 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 required version of Jinja2 for this role 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 From 1175038afc146e3817c8659e4baf108578427625 Mon Sep 17 00:00:00 2001 From: alessfg Date: Wed, 24 Mar 2021 18:20:19 +0100 Subject: [PATCH 5/5] Update README.md --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 22c28b915..e28b5bfce 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,8 @@ With the advent of Ansible collections and the release of the [NGINX Core Ansibl ### 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 --- collections: @@ -30,17 +31,17 @@ With the advent of Ansible collections and the release of the [NGINX Core Ansibl - name: ansible.posix 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). ### 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 required version of Jinja2 for this role is `2.11`. +* 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 `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). ## Installation