From e7319445150321553c9f4cdf8c2307591816b062 Mon Sep 17 00:00:00 2001 From: alessfg Date: Wed, 28 Apr 2021 20:52:58 +0200 Subject: [PATCH] Prepare 0.19.2 release And update contribution guidelines to specify that not all Molecule tests necessarily need to be run before submitting a PR --- .github/pull_request_template.md | 2 +- CHANGELOG.md | 2 +- CONTRIBUTING.md | 16 ++++++++-------- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index f07653a..21b97ff 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -6,5 +6,5 @@ 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/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 checked that any relevant Molecule tests pass after adding my changes - [ ] I have updated any relevant documentation (`defaults/main/*.yml`, `README.md` and `CHANGELOG.md`) diff --git a/CHANGELOG.md b/CHANGELOG.md index 84e72fc..2924049 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## 0.19.2 (Unreleased) +## 0.19.2 (April 28, 2021) FEATURES: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a776a0d..61344a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,12 +28,12 @@ Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx/b * The NGINX Ansible role is written in `yaml` and supports NGINX Open Source, NGINX Plus, and NGINX Amplify. * 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/`. - * 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. + * The main code is found in [`tasks/`](https://github.com/nginxinc/ansible-role-nginx/blob/main/tasks/). + * Variables can be found in [`defaults/main/`](https://github.com/nginxinc/ansible-role-nginx/blob/main/defaults/main/). + * "Constant" variables can be found in [`vars/main.yml`](https://github.com/nginxinc/ansible-role-nginx/blob/main/vars/main.yml). + * Configuration templates for NGINX can be found in [`templates/`](https://github.com/nginxinc/ansible-role-nginx/blob/main/templates/). + * [Molecule](https://molecule.readthedocs.io/) tests can be found in [`molecule/`](https://github.com/nginxinc/ansible-role-nginx/blob/main/molecule/). + * CI/CD is done via GitHub actions using the workflow files found in [`.github/workflows/`](https://github.com/nginxinc/ansible-role-nginx/blob/main/.github/workflows/). ## Contributing @@ -47,7 +47,7 @@ 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. +* Fork the repo, create a branch, implement your changes, add any relevant Molecule tests, submit a PR when your changes are **tested** (using Molecule) and ready for review. * Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx/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. @@ -57,7 +57,7 @@ Note: if you’d like to implement a new feature, please consider creating a fea ### Ansible Guidelines * Run `molecule lint` over your code to automatically resolve a lot of `yaml` and Ansible style issues. -* Run `molecule test --all` on your code before you submit a PR to catch any potential issues. +* Run `molecule test` on your code before you submit a PR to catch any potential issues. If you are testing a specific molecule scenario, run `molecule test -s `. If you are testing the NGINX Plus scenario (`plus`), you will need to procure an NGINX Plus license (check out the [NGINX Plus developer license FAQ](https://www.nginx.com/developer-license-faqs/) to find out how to request one). * Follow these guides on some good practices for Ansible: * *