Skip to content

Commit

Permalink
Prepare 0.8.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
alessfg committed Jan 30, 2023
1 parent ac435b5 commit 8752c7c
Show file tree
Hide file tree
Showing 21 changed files with 198 additions and 113 deletions.
13 changes: 7 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
title: ""
labels: ""
assignees: ""
---

### Describe the bug

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

Steps to reproduce the behavior:

1. Deploy NGINX collection using playbook.yml
2. View output/logs/configuration on '...'
1. Deploy the Ansible NGINX Core collection using `playbook.yml`
2. View output/logs/configuration on ...
3. See error

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

### Your environment

- Version of the NGINX collection or specific commit
- Version of the Ansible NGINX Core collection or specific commit
- Version of Ansible
- Version of Jinja2 (if you are using any templating capability)
- Target deployment platform
Expand Down
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
title: ""
labels: ""
assignees: ""
---

### Is your feature request related to a problem? Please describe

A clear and concise description of what the problem is. Ex. I'm always frustrated when ...
Expand Down
26 changes: 26 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Security Policy

## Versions

### Latest Versions

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.

### Supported Versions

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).

## Reporting a Vulnerability

### Ansible

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).

### Codebase

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):

- If you’re an F5 customer with an active support contract, please contact [F5 Technical Support](https://www.f5.com/services/support).
- If you aren’t an F5 customer, please report any potential or current instances of security vulnerabilities to the F5 SIRT at <[email protected]>.

For more information visit [https://www.f5.com/services/support/report-a-vulnerability](https://www.f5.com/services/support/report-a-vulnerability)
12 changes: 0 additions & 12 deletions .yamllint

This file was deleted.

32 changes: 20 additions & 12 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,44 @@
# CHANGELOG

## 0.8.0 (January 29, 2023)

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:

- Ansible NGINX role's [changelog](https://github.com/nginxinc/ansible-role-nginx/blob/0.24.0/CHANGELOG.md)
- Ansible NGINX config role's [changelog](https://github.com/nginxinc/ansible-role-nginx-config/blob/0.6.0/CHANGELOG.md)
- Ansible NGINX App Protect role's [changelog](https://github.com/nginxinc/ansible-role-nginx-app-protect/blob/0.9.0/CHANGELOG.md)

## 0.7.0 (October 17, 2022)

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:

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

## 0.6.0 (April 7, 2022)

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:

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

## 0.5.0 (February 17, 2022)

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:

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

## 0.4.0 (October 28, 2021)

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:

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

## 0.3.0 (January 11, 2021)

Expand Down
23 changes: 10 additions & 13 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,19 @@ appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment
include:

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

Examples of unacceptable behavior by participants include:

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

## Our Responsibilities

Expand Down
40 changes: 20 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ The following is a set of guidelines for contributing to the NGINX Ansible colle

[Code Guidelines](#code-guidelines)

* [Git Guidelines](#git-guidelines)
* [Ansible Guidelines](#ansible-guidelines)
- [Git Guidelines](#git-guidelines)
- [Ansible Guidelines](#ansible-guidelines)

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

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

### Project Structure

* The NGINX Ansible collection is written in `yaml` and supports NGINX Open Source, NGINX Plus and NGINX App Protect.
* The project follows the standard [Ansible collection directory structure](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections.html):
* 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).
* Sample playbooks and instructions can be found in the [`playbooks/`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/) directory.
- The NGINX Ansible collection is written in `yaml` and supports NGINX Open Source, NGINX Plus and NGINX App Protect.
- The project follows the standard [Ansible collection directory structure](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections.html):
- 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).
- Sample playbooks and instructions can be found in the [`playbooks/`](https://github.com/nginxinc/ansible-collection-nginx/blob/main/playbooks/) directory.

## Contributing

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

### Open a Pull Request

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

## Code Guidelines

### Ansible Guidelines

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

### 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 summarized 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 summarized 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`).
Loading

0 comments on commit 8752c7c

Please sign in to comment.