Skip to content

Commit

Permalink
Update RTD with GHA workflow and testing information
Browse files Browse the repository at this point in the history
Signed-off-by: NilashishC <[email protected]>
  • Loading branch information
NilashishC committed Jan 16, 2024
1 parent 8df21e1 commit f471795
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions .config/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -161,4 +161,5 @@ viewcode
volmount
wantd
workdir
xdist
xmss
15 changes: 15 additions & 0 deletions docs/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,18 @@ $ tree -lla /home/ansible-dev/collections/ansible_collections
└── .vscode
└── extensions.json
```

**Note:**

The scaffolded collection includes a `hello_world` filter plugin, along with an integration test target for it, that can be run using `molecule` and `pytest-ansible`. This serves as an example for you to refer when writing tests your own Ansible plugins and can be removed when it is no longer required.

To run the `hello_world` integration test, follow these steps:

- Git initialize the repository containing the scaffolded collection with `git init`.
- `pip install ansible-core molecule pytest-xdist pytest-ansible`.
- Invoke `pytest` from collection root.

It also comes equipped with Github Action Workflows that use [ansible-content-actions](https://github.com/marketplace/actions/ansible-content-actions) for testing and publishing the collection. For details on how to use these, please refer to the following:

- [Using the testing workflow](https://github.com/ansible/ansible-content-actions/blob/main/docs/ci.md)
- [Using the release workflow](https://github.com/ansible/ansible-content-actions/blob/main/docs/release.md)

0 comments on commit f471795

Please sign in to comment.