Skip to content
This repository has been archived by the owner on May 28, 2024. It is now read-only.

Commit

Permalink
Add new rule on files outside of meta/, plugins/, roles/, and playboo…
Browse files Browse the repository at this point in the history
  • Loading branch information
felixfontein committed Mar 12, 2022
1 parent bbec2b1 commit 4f27a54
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions collection_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ Every comment should say whether the reviewer expects it to be addressed, or whe
- [ ] modules (or plugins) from ansible-core use `ansible.builtin.` as a FQCN prefix
- [ ] documentation and return sections use `version_added:` containing the *collection* version for which an option, module or plugin was added
- [ ] FQCNs are used for `extends_documentation_fragment:`, unless you are referring to doc_fragments from ansible-core
- [ ] public plugins, roles and playbooks do not use files outside of `meta/`, `plugins/`, `roles/`, and `playbooks/`

**Collection management:**
- [ ] `galaxy.yml` having `tags` field set
Expand Down
7 changes: 7 additions & 0 deletions collection_requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,13 @@ Modules & Plugins
The core team (which maintains ansible-core) has committed not to use these directories for
anything which would conflict with the uses we've specified.

Other directories
-----------------

Collections MUST not use files outside ``meta/``, ``plugins/``, ``roles/`` and ``playbooks/`` in public plugins, roles and playbooks they contain. They must work if every file or directory is deleted from the installed collection except these directories and their contents.

In the previous paragraph, `"public"` means that internal plugins, roles and playbooks, for example which are part of tests, only used to release the collection, etc. are not affected. Everything that can be used from other collections or user playbooks and roles, as well as playbooks that can be called by FQCN, is public.


Documentation
~~~~~~~~~~~~~~
Expand Down

0 comments on commit 4f27a54

Please sign in to comment.