Skip to content

Commit

Permalink
Add explicit Jinja2 requirement (#104)
Browse files Browse the repository at this point in the history
Explicitly list Jinja2 `2.11.3` as a requirement, as well as detail the minimum supported version (`2.11.x`).
  • Loading branch information
alessfg committed Mar 24, 2021
1 parent cca1946 commit fa49aa0
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 12 deletions.
1 change: 1 addition & 0 deletions .github/workflows/requirements/requirements_molecule.txt
@@ -1,4 +1,5 @@
ansible-base==2.10.7
Jinja2==2.11.3
ansible-lint==5.0.5
yamllint==1.26.0
molecule[docker]==3.3.0
Expand Down
19 changes: 10 additions & 9 deletions CHANGELOG.md
Expand Up @@ -41,15 +41,16 @@ The `nginx_config_main_upload_*`, `nginx_config_upload_html_*`, and `nginx_confi

FEATURES:

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

ENHANCEMENTS:

Expand Down
12 changes: 9 additions & 3 deletions README.md
Expand Up @@ -14,7 +14,8 @@ This role configures NGINX Open Source and NGINX Plus on your target host.

### 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 collection:
* 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:
Expand All @@ -23,12 +24,17 @@ This role configures NGINX Open Source and NGINX Plus on your target host.
- 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 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
Expand Down

0 comments on commit fa49aa0

Please sign in to comment.