Skip to content

Commit e731944

Browse files
committed
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
1 parent f3ec49b commit e731944

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ Before creating a PR, run through this checklist and mark each as complete.
66

77
- [ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx/blob/main/CONTRIBUTING.md) document
88
- [ ] I have added Molecule tests that prove my fix is effective or that my feature works
9-
- [ ] I have checked that all Molecule tests pass after adding my changes
9+
- [ ] I have checked that any relevant Molecule tests pass after adding my changes
1010
- [ ] I have updated any relevant documentation (`defaults/main/*.yml`, `README.md` and `CHANGELOG.md`)

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
## 0.19.2 (Unreleased)
3+
## 0.19.2 (April 28, 2021)
44

55
FEATURES:
66

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx/b
2828

2929
* The NGINX Ansible role is written in `yaml` and supports NGINX Open Source, NGINX Plus, and NGINX Amplify.
3030
* The project follows the standard [Ansible role directory structure](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html):
31-
* The main code is found in `tasks/`.
32-
* Variables can be found in `defaults/main/*.yml`.
33-
* "Constant" variables can be found in `vars/main.yml`.
34-
* Configuration templates for NGINX can be found in `templates/`.
35-
* [Molecule](https://molecule.readthedocs.io/) tests can be found in `molecule/`.
36-
* CI/CD is done via Travis using `.travis.yml` deployment `yaml` files.
31+
* The main code is found in [`tasks/`](https://github.com/nginxinc/ansible-role-nginx/blob/main/tasks/).
32+
* Variables can be found in [`defaults/main/`](https://github.com/nginxinc/ansible-role-nginx/blob/main/defaults/main/).
33+
* "Constant" variables can be found in [`vars/main.yml`](https://github.com/nginxinc/ansible-role-nginx/blob/main/vars/main.yml).
34+
* Configuration templates for NGINX can be found in [`templates/`](https://github.com/nginxinc/ansible-role-nginx/blob/main/templates/).
35+
* [Molecule](https://molecule.readthedocs.io/) tests can be found in [`molecule/`](https://github.com/nginxinc/ansible-role-nginx/blob/main/molecule/).
36+
* 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/).
3737

3838
## Contributing
3939

@@ -47,7 +47,7 @@ To suggest an enhancement, please create an issue on GitHub with the label `enha
4747

4848
### Open a Pull Request
4949

50-
* Fork the repo, create a branch, submit a PR when your changes are **tested** (ideally using Molecule) and ready for review.
50+
* 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.
5151
* Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx/blob/main/.github/PULL_REQUEST_TEMPLATE.md).
5252

5353
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
5757
### Ansible Guidelines
5858

5959
* Run `molecule lint` over your code to automatically resolve a lot of `yaml` and Ansible style issues.
60-
* Run `molecule test --all` on your code before you submit a PR to catch any potential issues.
60+
* 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 <scenario>`. 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).
6161
* Follow these guides on some good practices for Ansible:
6262
* <https://www.ansible.com/blog/ansible-best-practices-essentials>
6363
* <https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html>

0 commit comments

Comments
 (0)