You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 24, 2023. It is now read-only.
Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to that issue using one of the [supported keywords](https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) here in this description (not in the title of the PR).
3
4
4
5
### Checklist
6
+
5
7
Before creating a PR, run through this checklist and mark each as complete.
6
8
7
-
-[ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/CONTRIBUTING.md) document
8
-
-[ ] I have added Molecule tests that prove my fix is effective or that my feature works
9
-
-[ ] I have checked that any relevant Molecule tests pass after adding my changes
10
-
-[ ] I have updated any relevant documentation (`defaults/main/*.yml`, `README.md` and `CHANGELOG.md`)
9
+
-[ ] I have read the [CONTRIBUTING](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/CONTRIBUTING.md) document
10
+
-[ ] I have added Molecule tests that prove my fix is effective or that my feature works
11
+
-[ ] I have checked that any relevant Molecule tests pass after adding my changes
12
+
-[ ] I have updated any relevant documentation (`defaults/main/*.yml`, `README.md` and `CHANGELOG.md`)
Copy file name to clipboardExpand all lines: .github/release-drafter.yml
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -88,12 +88,12 @@ template: |
88
88
89
89
## Install & Upgrade
90
90
91
-
* To install the Ansible NGINX Controller Install role on a fresh environment, run `ansible-galaxy install nginxinc.nginx_controller_install`.
92
-
* To upgrade the Ansible NGINX Controller Install role to the latest release, run `ansible-galaxy install -f nginxinc.nginx_controller_install`.
93
-
* To install or upgrade to this specific Ansible NGINX Controller Install role release ($RESOLVED_VERSION), run `ansible-galaxy install -f nginxinc.nginx_controller_install,v$RESOLVED_VERSION`.
91
+
* To install the Ansible NGINX Controller Install role on a fresh environment, run `ansible-galaxy install nginxinc.nginx_controller_install`.
92
+
* To upgrade the Ansible NGINX Controller Install role to the latest release, run `ansible-galaxy install -f nginxinc.nginx_controller_install`.
93
+
* To install or upgrade to this specific Ansible NGINX Controller Install role release ($RESOLVED_VERSION), run `ansible-galaxy install -f nginxinc.nginx_controller_install,v$RESOLVED_VERSION`.
94
94
95
95
## Resources
96
96
97
-
* Functional configuration examples (check `converge.yml` under each `molecule` scenario) -- [github.com/nginxinc/ansible-role-nginx-controller-install/tree/$RESOLVED_VERSION/molecule](https://github.com/nginxinc/ansible-role-nginx-controller-install/tree/$RESOLVED_VERSION/molecule).
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+27-26Lines changed: 27 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,29 +11,30 @@ The following is a set of guidelines for contributing to the NGINX Controller In
11
11
[Contributing](#contributing)
12
12
13
13
[Code Guidelines](#code-guidelines)
14
-
*[Git Guidelines](#git-guidelines)
15
-
*[Ansible Guidelines](#ansible-guidelines)
16
14
17
-
[Code of Conduct](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/CODE_OF_CONDUCT.md)
15
+
*[Git Guidelines](#git-guidelines)
16
+
*[Ansible Guidelines](#ansible-guidelines)
17
+
18
+
[Code of Conduct](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/CODE_OF_CONDUCT.md)
18
19
19
20
## Ask a Question
20
21
21
22
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`.
22
23
23
24
## Getting Started
24
25
25
-
Follow our [Installation Guide](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/README.md#Installation) to install Ansible and Molecule and get ready to use the NGINX Controller Install Ansible role.
26
+
Follow our [Installation Guide](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/README.md#Installation) to install Ansible and Molecule and get ready to use the NGINX Controller Install Ansible role.
26
27
27
28
### Project Structure
28
29
29
-
*The NGINX Controller Install Ansible role is written in `yaml` and supports NGINX Controller.
30
-
*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/`](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/tasks/).
32
-
*Variables can be found in [`defaults/main/`](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/defaults/main/).
33
-
*"Constant" variables can be found in [`vars/main.yml`](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/vars/main.yml).
34
-
*Configuration templates for NGINX can be found in [`templates/`](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/templates/).
35
-
*[Molecule](https://molecule.readthedocs.io/) tests can be found in [`molecule/`](https://github.com/nginxinc/ansible-role-nginx-controller-install/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-controller-install/blob/main/.github/workflows/).
30
+
* The NGINX Controller Install Ansible role is written in `yaml` and supports NGINX Controller.
31
+
* The project follows the standard [Ansible role directory structure](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html)
32
+
*The main code is found in [`tasks/`](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/tasks/).
33
+
*Variables can be found in [`defaults/main/`](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/defaults/main/).
34
+
*"Constant" variables can be found in [`vars/main.yml`](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/vars/main.yml).
35
+
*Configuration templates for NGINX can be found in [`templates/`](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/templates/).
36
+
*[Molecule](https://molecule.readthedocs.io/) tests can be found in [`molecule/`](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/molecule/).
37
+
*CI/CD is done via GitHub actions using the workflow files found in [`.github/workflows/`](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/.github/workflows/).
37
38
38
39
## Contributing
39
40
@@ -47,27 +48,27 @@ To suggest an enhancement, please create an issue on GitHub with the label `enha
47
48
48
49
### Open a Pull Request
49
50
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.
51
-
*Fill in [our pull request template](https://github.com/nginxinc/ansible-role-nginx-controller-install/blob/main/.github/pull_request_template.md).
51
+
* 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.
52
+
* Fill in [our pull request template](https://github.com/nginxinc/ansible_role_nginx_controller_install/blob/main/.github/pull_request_template.md).
52
53
53
54
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.
54
55
55
56
## Code Guidelines
56
57
57
58
### Ansible Guidelines
58
59
59
-
*Run `molecule lint` over your code to automatically resolve a lot of `yaml` and Ansible style 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>`.
61
-
*Follow these guides on some good practices for Ansible:
* Run `molecule lint` over your code to automatically resolve a lot of `yaml` and Ansible style issues.
61
+
* 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>`.
62
+
* Follow these guides on some good practices for Ansible:
*Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR
68
-
*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
69
-
* In the subject line, use the present tense ("Add feature" not "Added feature")
70
-
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
71
-
* Limit the subject line to 72 characters or less
72
-
* Reference issues and pull requests liberally after the subject line
73
-
* 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`)
68
+
* Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR
69
+
* 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
70
+
* In the subject line, use the present tense ("Add feature" not "Added feature")
71
+
* In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
72
+
* Limit the subject line to 72 characters or less
73
+
* Reference issues and pull requests liberally after the subject line
74
+
* 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