Update docs to fix master references (#25)

Author: alessfg

.github/ISSUE_TEMPLATE/bug_report.md

@@ -20,7 +20,7 @@ Steps to reproduce the behavior:
 A clear and concise description of what you expected to happen.
 
 **Your environment:**
--   Version of the NGINX Config Role or specific commit
+-   Version of the NGINX Config role or specific commit
 -   Version of Ansible
 -   Target deployment platform
 

.github/pull_request_template.md

@@ -4,7 +4,7 @@ Describe the use case and detail of the change. If this PR addresses an issue on
 ### Checklist
 Before creating a PR, run through this checklist and mark each as complete.
 
--   [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx-config/blob/master/CONTRIBUTING.md) document
+-   [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/CONTRIBUTING.md) document
 -   [ ] I have added Molecule tests that prove my fix is effective or that my feature works
 -   [ ] I have checked that all Molecule tests pass after adding my changes
 -   [ ] I have updated any relevant documentation (`defaults/main/*.yml`, `README.md` and `CHANGELOG.md`)

.travis.yml

@@ -6,7 +6,7 @@ jobs:
     - name: "(Debian/Ubuntu) Cleanup config and try to install modules"
       env:
         scenario: cleanup_module
-    - name: "(Alpine) Cleanup config and try to install modules"
+    - name: "(Alpine Linux) Cleanup config and try to install modules"
       env:
         scenario: cleanup_module_alpine
     - name: "(CentOS) Cleanup config and try to install modules"
@@ -15,7 +15,7 @@ jobs:
     - name: "(Debian/Ubuntu) Test config templates"
       env:
         scenario: default
-    - name: "(Alpine) Test config templates"
+    - name: "(Alpine Linux) Test config templates"
       env:
         scenario: default_alpine
     - name: "(CentOS) Test config templates"
@@ -24,7 +24,7 @@ jobs:
     - name: "(Debian/Ubuntu) Install stable branch and push a config"
       env:
         scenario: stable_push
-    - name: "(Alpine) Install stable branch and push a config"
+    - name: "(Alpine Linux) Install stable branch and push a config"
       env:
         scenario: stable_push_alpine
     - name: "(CentOS) Install stable branch and push a config"

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## 0.2.0 (Unreleased)
+## 0.2.0 (September 13, 2020)
 
 BREAKING CHANGES:
 
@@ -12,8 +12,11 @@ Make sure you only use one variable or the other, since they will overwrite each
 
 FEATURES:
 
-*   Add Alpine 3.12 to the list of supported platforms
-*   Remove Alpine 3.8 from the list of supported platforms 
+*   A new variable has been introduced:
+    *   `nginx_debug_tasks` -- Print task related information to give you a better insight into the current progress of the role.
+*   Improved tasks naming conventions.
+*   Add Alpine `3.12` to the list of supported platforms.
+*   Remove Alpine `3.8` from the list of supported platforms .
 
 ENHANCEMENTS:
 

CONTRIBUTING.md

@@ -14,25 +14,26 @@ The following is a set of guidelines for contributing to the NGINX Ansible role.
 *   [Git Guidelines](#git-guidelines)
 *   [Ansible Guidelines](#ansible-guidelines)
 
-[Code of Conduct](https://github.com/nginxinc/ansible-role-nginx-config/blob/master/CODE_OF_CONDUCT.md)
+[Code of Conduct](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/CODE_OF_CONDUCT.md)
 
 ## Ask a Question
 
-Don't know how something works? Curious if the role can achieve your desired functionality. Please open an Issue on GitHub with the label `question`.
+Don't know how something works? Curious if the role can achieve your desired functionality? Please open an Issue on GitHub with the label `question`.
 
 ## Getting Started
 
-Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx-config/blob/master/README.md#Installation) to install Ansible and Molecule and get ready to use the NGINX Ansible role.
+Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/README.md#Installation) to install Ansible and Molecule and get ready to use the NGINX Ansible role.
 
 ### Project Structure
 
 *   The NGINX Ansible role is written in `yaml` and supports NGINX Open Source and NGINX Plus.
-*   The project follows the standard [Ansible role directory structure](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html)
-    *   The main code is found in `tasks/`
-    *   The main variables can be found in `defaults/main/*.yml`
-    *   Configuration templates for NGINX can be found in `templates/`
+*   The project follows the standard [Ansible role directory structure](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html):
+    *   The main code is found in `tasks/`.
+    *   The main variables can be found in `defaults/main/*.yml`.
+    *   "Constant" variables can be found in `vars/main.yml`.
+    *   Configuration templates for NGINX can be found in `templates/`.
     *   [Molecule](https://molecule.readthedocs.io/) tests can be found in `molecule/`.
-    *   CI/CD is done via Travis using `.travis.yml` deployment yaml files
+    *   CI/CD is done via Travis using `.travis.yml` deployment `yaml` files.
 
 ## Contributing
 
@@ -46,8 +47,8 @@ To suggest an enhancement, please create an issue on GitHub with the label `enha
 
 ### Open a Pull Request
 
-*   Fork the repo, create a branch, submit a PR when your changes are **tested** (ideally using Molecule) and ready for review
-*   Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx-config/blob/master/.github/PULL_REQUEST_TEMPLATE.md)
+*   Fork the repo, create a branch, submit a PR when your changes are **tested** (ideally using Molecule) and ready for review.
+*   Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/.github/PULL_REQUEST_TEMPLATE.md).
 
 Note: if you’d like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.
 
@@ -63,10 +64,10 @@ Note: if you’d like to implement a new feature, please consider creating a fea
 
 ### Git Guidelines
 
-*   Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR
-*   Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarised in the next few points
-    *   In the subject line, use the present tense ("Add feature" not "Added feature")
-    *   In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
-    *   Limit the subject line to 72 characters or less
-    *   Reference issues and pull requests liberally after the subject line
-    *   Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`)
+*   Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
+*   Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarised in the next few points:
+    *   In the subject line, use the present tense ("Add feature" not "Added feature").
+    *   In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
+    *   Limit the subject line to 72 characters or less.
+    *   Reference issues and pull requests liberally after the subject line.
+    *   Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).

README.md

@@ -44,14 +44,11 @@ Alpine:
   - 3.12
 CentOS:
   - 6
-  - 7
+  - 7.4+
   - 8
 Debian:
   - stretch
   - buster
-FreeBSD:
-  - 11.2+
-  - 12
 RedHat:
   - 6
   - 7.4+
@@ -62,6 +59,7 @@ SUSE/SLES:
 Ubuntu:
   - xenial
   - bionic
+  - eoan
   - focal
 ```
 
@@ -100,13 +98,14 @@ SUSE/SLES:
 Ubuntu:
   - xenial
   - bionic
+  - eoan
   - focal
 ```
 
 Role Variables
 --------------
 
-This role has multiple variables. The descriptions and defaults for all these variables can be found in the **`defaults/main`** directory in the following files:
+This role has multiple variables. The descriptions and defaults for all these variables can be found in the **`defaults/main/`** directory in the following files:
 
 -   **[defaults/main/main.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/main.yml):** NGINX simple config variables
 -   **[defaults/main/template.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/defaults/main/template.yml):** NGINX config template variables
@@ -115,7 +114,7 @@ This role has multiple variables. The descriptions and defaults for all these va
 Example Playbooks
 -----------------
 
-Working functional playbook examples can be found in the **`molecule/common`** directory in the following files:
+Working functional playbook examples can be found in the **`molecule/common/`** directory in the following files:
 
 -   **[molecule/common/playbooks/cleanup_module_converge.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/common/playbooks/cleanup_module_converge.yml):** Cleanup an NGINX config and configure NGINX supported modules
 -   **[molecule/common/playbooks/default_converge.yml](https://github.com/nginxinc/ansible-role-nginx-config/blob/main/molecule/common/playbooks/default_converge.yml):** Use the NGINX config templating variables to create an NGINX config
@@ -126,10 +125,14 @@ Do note that if you install this repository via Ansible Galaxy, you will have to
 Other NGINX Roles
 -----------------
 
-You can find an Ansible collection of roles to help you install and configure NGINX Controller [here](https://github.com/nginxinc/ansible-collection-nginx_controller)
+You can find an Ansible role to install NGINX [here](https://github.com/nginxinc/ansible-role-nginx)
 
 You can find an Ansible role to help you install and configure NGINX App Protect [here](https://github.com/nginxinc/ansible-role-nginx-app-protect)
 
+You can find an Ansible collection of roles to help you install and configure NGINX Controller [here](https://github.com/nginxinc/ansible-collection-nginx_controller)
+
+You can find an Ansible role to install NGINX Unit [here](https://github.com/nginxinc/ansible-role-nginx-unit)
+
 License
 -------
 

defaults/main/main.yml

@@ -5,6 +5,8 @@ nginx_config_start: true
 
 # Print NGINX configuration file to terminal after executing playbook.
 nginx_config_debug_output: false
+# Print NGINX configuration file to terminal after executing playbook.
+nginx_config_debug_tasks: false
 
 # Remove previously existing NGINX configuration files (files ending in *.conf).
 # You can specify a list of paths you wish to remove.

handlers/main.yml

@@ -1,19 +1,19 @@
 ---
-- name: "(Handler: All OSs) Run NGINX"
+- name: "(Handler) Run NGINX"
   block:
-    - name: "(Handler: All OSs) Start NGINX"
+    - name: "(Handler) Start NGINX"
       service:
         name: nginx
         state: started
         enabled: yes
-      notify: "(Handler: All OSs) Check NGINX"
+      notify: "(Handler) Check NGINX"
 
-    - name: "(Handler: All OSs) Check NGINX"
+    - name: "(Handler) Check NGINX"
       command: "nginx -t"
-      notify: "(Handler: All OSs) Start NGINX"
+      notify: "(Handler) Start NGINX"
       changed_when: false
 
-    - name: "(Handler: All OSs) Reload NGINX"
+    - name: "(Handler) Reload NGINX"
       command: "nginx -s reload"
       changed_when: false
   when:

molecule/common/Dockerfile.j2

@@ -17,27 +17,27 @@ ENV {{ var }} {{ value }}
 RUN \
   if [ $(command -v apt-get) ]; then \
     apt-get update \
-    && DEBIAN_FRONTEND=noninteractive apt-get install -y python3 sudo bash ca-certificates iproute2 python3-apt aptitude systemd systemd-sysv procps curl \
+    && DEBIAN_FRONTEND=noninteractive apt-get install -y aptitude bash ca-certificates curl iproute2 python-apt python3 python3-apt procps sudo systemd systemd-sysv \
     && apt-get clean; \
   elif [ $(command -v dnf) ]; then \
     dnf makecache \
-    && dnf --assumeyes install /usr/bin/python3 /usr/bin/python3-config /usr/bin/dnf-3 bash iproute \
+    && dnf --assumeyes install bash iproute /usr/bin/dnf-3 /usr/bin/python3 /usr/bin/python3-config \
     && dnf clean all; \
   elif [ $(command -v yum) ]; then \
     yum makecache fast \
-    && yum install -y /usr/bin/python /usr/bin/python2-config sudo yum-plugin-ovl bash iproute \
+    && yum install -y bash iproute /usr/bin/python /usr/bin/python2-config sudo yum-plugin-ovl \
     && sed -i 's/plugins=0/plugins=1/g' /etc/yum.conf \
     && yum clean all; \
   elif [ $(command -v zypper) ]; then \
     zypper refresh \
-    && zypper install -y python3 sudo bash iproute2 \
+    && zypper install -y bash iproute2 python3 sudo \
     && zypper clean -a; \
   elif [ $(command -v apk) ]; then \
     apk update \
-    && apk add --no-cache python3 sudo bash ca-certificates curl openrc; \
+    && apk add --no-cache bash ca-certificates curl openrc python3 sudo; \
     echo 'rc_provide="loopback net"' >> /etc/rc.conf; \
   elif [ $(command -v xbps-install) ]; then \
     xbps-install -Syu \
-    && xbps-install -y python3 sudo bash ca-certificates iproute2 \
+    && xbps-install -y bash ca-certificates iproute2 python3 sudo \
     && xbps-remove -O; \
   fi