Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify the usage of LICENSE template in docs #252

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Commands:

## Usage

Full documentation on how to use this, along with it's integration with VS Code Ansible Extension can be found in https://ansible.readthedocs.io/projects/creator/.
Full documentation on how to use this, along with its integration with VS Code Ansible Extension can be found in https://ansible.readthedocs.io/projects/creator/.

## Upcoming features

Expand Down
14 changes: 9 additions & 5 deletions docs/installing.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,13 +171,17 @@ $ tree -lla /home/ansible-dev/collections/ansible_collections/testns/testname

**Note:**

The scaffolded collection includes a `hello_world` filter plugin, along with a molecule scenario and an integration test target for it, that can be run using `pytest`. This serves as an example for you to refer when writing tests for your Ansible plugins and can be removed when it is no longer required.
1. The scaffolded collection includes a `LICENSE` template. This serves as
an example and can be replaced with a licensing policy of your choice. Feel free to adapt the license to best suit your project's needs and
legal requirements.

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

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

### Initialize Ansible Project

Expand Down
Loading