Skip to content

Commit a5a368d

Browse files
author
Sebastian Gumprich
committed
clarify linting
1 parent dcb8eb1 commit a5a368d

1 file changed

Lines changed: 4 additions & 28 deletions

File tree

README.md

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,10 @@ Then you can use the dynamic inventory like this:
132132
ansible-playbook -i inventory.icinga_director_inventory.yaml path/to/your/playbook.yml
133133
```
134134

135+
## Contributing
136+
137+
See [Contributing](CONTRIBUTING.md).
138+
135139
## Troubleshooting
136140

137141
If the following error is thrown, check if you're behind a proxy and use `force_basic_auth: true` in the task.
@@ -140,34 +144,6 @@ If the following error is thrown, check if you're behind a proxy and use `force_
140144
fatal: [localhost]: FAILED! => {"changed": false, "msg": "bad return code while creating: -1. Error message: Request failed: <urlopen error Tunnel connection failed: 302 Found>"}
141145
```
142146

143-
## Local Development and testing
144-
145-
### Linting with tox
146-
147-
```
148-
> tox -elinters
149-
```
150-
151-
### Updating the tests and examples
152-
153-
If you add new features or arguments to the existing modules, please add them to the examples in the module itself.
154-
The integration tests and examples in our documentation are then generated from the module-examples.
155-
156-
To trigger this generation, you need to run the script `hacking/update_examples_and_tests.sh` from the root of the repository. For this you need to have yq in version 3 installed (see https://mikefarah.gitbook.io/yq/v/v3.x/).
157-
158-
### Integration tests with docker
159-
160-
```
161-
# run icinga in a container and forward port 80
162-
> docker run -d -p 80:80 schurzi/icinga2
163-
164-
# run ansible-test
165-
> ansible-test integration
166-
167-
# alternatively run the test playbooks against the container
168-
> ansible-playbook tests/integration/targets/icinga/normalmode.yml
169-
> ansible-playbook tests/integration/targets/icinga/checkmode.yml
170-
```
171147

172148
## Extras
173149

0 commit comments

Comments
 (0)