Skip to content

Commit 8752c7c

Browse files
committed
Prepare 0.8.0 release
1 parent ac435b5 commit 8752c7c

21 files changed

+198
-113
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
6-
assignees: ''
4+
title: ""
5+
labels: ""
6+
assignees: ""
77
---
8+
89
### Describe the bug
910

1011
A clear and concise description of what the bug is.
@@ -13,8 +14,8 @@ A clear and concise description of what the bug is.
1314

1415
Steps to reproduce the behavior:
1516

16-
1. Deploy NGINX collection using playbook.yml
17-
2. View output/logs/configuration on '...'
17+
1. Deploy the Ansible NGINX Core collection using `playbook.yml`
18+
2. View output/logs/configuration on ...
1819
3. See error
1920

2021
### Expected behavior
@@ -23,7 +24,7 @@ A clear and concise description of what you expected to happen.
2324

2425
### Your environment
2526

26-
- Version of the NGINX collection or specific commit
27+
- Version of the Ansible NGINX Core collection or specific commit
2728
- Version of Ansible
2829
- Version of Jinja2 (if you are using any templating capability)
2930
- Target deployment platform

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
6-
assignees: ''
4+
title: ""
5+
labels: ""
6+
assignees: ""
77
---
8+
89
### Is your feature request related to a problem? Please describe
910

1011
A clear and concise description of what the problem is. Ex. I'm always frustrated when ...

.github/SECURITY.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Security Policy
2+
3+
## Versions
4+
5+
### Latest Versions
6+
7+
We advise users to run or update to the most recent release of the Ansible NGINX Core collection. Older versions of this collection may not have all enhancements and/or bug fixes applied to them.
8+
9+
### Supported Versions
10+
11+
This codebase mainly consists of an Ansible collection. Ansible applies security fixes to the most recent three releases. Please find more information in [the Ansible docs](https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html#release-status).
12+
13+
## Reporting a Vulnerability
14+
15+
### Ansible
16+
17+
If you find a security vulnerability that affects Ansible directly, we encourage you to report it according to the [Ansible guidelines](https://docs.ansible.com/ansible/devel/community/reporting_bugs_and_features.html#reporting-a-bug).
18+
19+
### Codebase
20+
21+
If you find a security vulnerability that affects the codebase, we encourage you to report it to the F5 Security Incident Response Team (F5 SIRT):
22+
23+
- If you’re an F5 customer with an active support contract, please contact [F5 Technical Support](https://www.f5.com/services/support).
24+
- If you aren’t an F5 customer, please report any potential or current instances of security vulnerabilities to the F5 SIRT at <[email protected]>.
25+
26+
For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability)

.yamllint

Lines changed: 0 additions & 12 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,44 @@
11
# CHANGELOG
22

3+
## 0.8.0 (January 29, 2023)
4+
5+
Update `nginx` role to `0.24.0`, `nginx_config` role to `0.6.0`, and `nginx_app_protect` role to `0.9.0`. Check each role's respective CHANGELOG to see what's changed since the latest NGINX collection release:
6+
7+
- Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.24.0/CHANGELOG.md)
8+
- Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.6.0/CHANGELOG.md)
9+
- Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.9.0/CHANGELOG.md)
10+
311
## 0.7.0 (October 17, 2022)
412

513
Update `nginx` role to `0.23.2`, `nginx_config` role to `0.5.2`, and `nginx_app_protect` role to `0.8.1`. Check each role's respective CHANGELOG to see what's changed since the latest NGINX collection release:
614

7-
* Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.23.2/CHANGELOG.md)
8-
* Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.5.2/CHANGELOG.md)
9-
* Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.8.1/CHANGELOG.md)
15+
- Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.23.2/CHANGELOG.md)
16+
- Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.5.2/CHANGELOG.md)
17+
- Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.8.1/CHANGELOG.md)
1018

1119
## 0.6.0 (April 7, 2022)
1220

1321
Update `nginx` role to `0.23.1`, `nginx_config` role to `0.5.1`, and `nginx_app_protect` role to `0.8.0`. Check each role's respective CHANGELOG to see what's changed since the latest NGINX collection release:
1422

15-
* Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.23.1/CHANGELOG.md)
16-
* Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.5.1/CHANGELOG.md)
17-
* Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.8.0/CHANGELOG.md)
23+
- Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.23.1/CHANGELOG.md)
24+
- Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.5.1/CHANGELOG.md)
25+
- Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.8.0/CHANGELOG.md)
1826

1927
## 0.5.0 (February 17, 2022)
2028

2129
Update `nginx` role to `0.23.0`, `nginx_config` role to `0.5.0`, and `nginx_app_protect` role to `0.7.1`. Check each role's respective CHANGELOG to see what's changed since the latest NGINX collection release:
2230

23-
* Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.23.0/CHANGELOG.md)
24-
* Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.5.0/CHANGELOG.md)
25-
* Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.7.1/CHANGELOG.md)
31+
- Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.23.0/CHANGELOG.md)
32+
- Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.5.0/CHANGELOG.md)
33+
- Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.7.1/CHANGELOG.md)
2634

2735
## 0.4.0 (October 28, 2021)
2836

2937
Update `nginx` role to `0.21.3`, `nginx_config` role to `0.4.2`, and `nginx_app_protect` role to `0.7.0`. Check each role's respective CHANGELOG to see what's changed since the latest NGINX collection release:
3038

31-
* Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.21.3/CHANGELOG.md)
32-
* Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.4.2/CHANGELOG.md)
33-
* Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.7.0/CHANGELOG.md)
39+
- Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.21.3/CHANGELOG.md)
40+
- Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.4.2/CHANGELOG.md)
41+
- Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.7.0/CHANGELOG.md)
3442

3543
## 0.3.0 (January 11, 2021)
3644

CODE_OF_CONDUCT.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,19 @@ appearance, race, religion, or sexual identity and orientation.
1414
Examples of behavior that contributes to creating a positive environment
1515
include:
1616

17-
* Using welcoming and inclusive language
18-
* Being respectful of differing viewpoints and experiences
19-
* Gracefully accepting constructive criticism
20-
* Focusing on what is best for the community
21-
* Showing empathy towards other community members
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
2222

2323
Examples of unacceptable behavior by participants include:
2424

25-
* The use of sexualized language or imagery and unwelcome sexual attention or
26-
advances
27-
* Trolling, insulting/derogatory comments, and personal or political attacks
28-
* Public or private harassment
29-
* Publishing others' private information, such as a physical or electronic
30-
address, without explicit permission
31-
* Other conduct which could reasonably be considered inappropriate in a
32-
professional setting
25+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
26+
- Trolling, insulting/derogatory comments, and personal or political attacks
27+
- Public or private harassment
28+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
29+
- Other conduct which could reasonably be considered inappropriate in a professional setting
3330

3431
## Our Responsibilities
3532

CONTRIBUTING.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ The following is a set of guidelines for contributing to the NGINX Ansible colle
1212

1313
[Code Guidelines](#code-guidelines)
1414

15-
* [Git Guidelines](#git-guidelines)
16-
* [Ansible Guidelines](#ansible-guidelines)
15+
- [Git Guidelines](#git-guidelines)
16+
- [Ansible Guidelines](#ansible-guidelines)
1717

1818
[Code of Conduct](ttps://github.com/nginxinc/ansible-collection-nginx/blob/main/CODE_OF_CONDUCT.md)
1919

@@ -27,10 +27,10 @@ Follow our [Installation Guide](https://github.com/nginxinc/ansible-collection-n
2727

2828
### Project Structure
2929

30-
* The NGINX Ansible collection is written in `yaml` and supports NGINX Open Source, NGINX Plus and NGINX App Protect.
31-
* The project follows the standard [Ansible collection directory structure](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections.html):
32-
* The main code is found in [`roles/`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/roles/) directory (do note that all roles are Git submodules).
33-
* Sample playbooks and instructions can be found in the [`playbooks/`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/) directory.
30+
- The NGINX Ansible collection is written in `yaml` and supports NGINX Open Source, NGINX Plus and NGINX App Protect.
31+
- The project follows the standard [Ansible collection directory structure](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections.html):
32+
- The main code is found in [`roles/`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/roles/) directory (do note that all roles are Git submodules).
33+
- Sample playbooks and instructions can be found in the [`playbooks/`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/) directory.
3434

3535
## Contributing
3636

@@ -44,27 +44,27 @@ To suggest an enhancement, please create an issue on GitHub with the label `enha
4444

4545
### Open a Pull Request
4646

47-
* Fork the repo, create a branch, implement your changes, submit a PR when your changes are **tested** and ready for review.
48-
* Fill in [our pull request template](https://github.com/nginxinc/ansible-collection-nginx/blob/main/.github/PULL_REQUEST_TEMPLATE.md).
47+
- Fork the repo, create a branch, implement your changes, submit a PR when your changes are **tested** and ready for review.
48+
- Fill in [our pull request template](https://github.com/nginxinc/ansible-collection-nginx/blob/main/.github/PULL_REQUEST_TEMPLATE.md).
4949

5050
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.
5151

5252
## Code Guidelines
5353

5454
### Ansible Guidelines
5555

56-
* Run `molecule lint` in each role directory to automatically resolve a lot of `yaml` and Ansible style issues.
57-
* Run `molecule test --all` in each role directory to catch any other issues.
58-
* Follow these guides on some good practices for Ansible:
59-
* <https://www.ansible.com/blog/ansible-best-practices-essentials>
60-
* <https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html>
56+
- Run `molecule lint` in each role directory to automatically resolve a lot of `yaml` and Ansible style issues.
57+
- Run `molecule test --all` in each role directory to catch any other issues.
58+
- Follow these guides on some good practices for Ansible:
59+
- <https://www.ansible.com/blog/ansible-best-practices-essentials>
60+
- <https://docs.ansible.com/ansible/latest/user_guide/playbooks_best_practices.html>
6161

6262
### Git Guidelines
6363

64-
* Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR
65-
* Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarized in the next few points:
66-
* In the subject line, use the present tense ("Add feature" not "Added feature").
67-
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
68-
* Limit the subject line to 72 characters or less.
69-
* Reference issues and pull requests liberally after the subject line.
70-
* 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`).
64+
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR
65+
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarized in the next few points:
66+
- In the subject line, use the present tense ("Add feature" not "Added feature").
67+
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
68+
- Limit the subject line to 72 characters or less.
69+
- Reference issues and pull requests liberally after the subject line.
70+
- 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`).

0 commit comments

Comments
 (0)