This repository has been archived by the owner on May 28, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 49
Add new rule on files outside of meta/, plugins/, roles/, and playbooks/ #199
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Andrew Klychkov <[email protected]>
Co-authored-by: Andrew Klychkov <[email protected]>
Andersson007
approved these changes
Mar 15, 2022
felixfontein
changed the title
[WIP] Add new rule on files outside of meta/, plugins/, roles/, and playbooks/
Add new rule on files outside of meta/, plugins/, roles/, and playbooks/
Mar 23, 2022
@Andersson007 thanks for reviewing this! |
acozine
reviewed
Mar 23, 2022
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested alternative wording.
Comment on lines
+162
to
+164
Collections MUST not use files outside ``meta/``, ``plugins/``, ``roles/`` and ``playbooks/`` in public plugins, roles and playbooks they contain. A collection 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 are not affected. Internal means that they are part of tests, only used to release the collection, etc. 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
Collections MUST not use files outside ``meta/``, ``plugins/``, ``roles/`` and ``playbooks/`` in public plugins, roles and playbooks they contain. A collection 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 are not affected. Internal means that they are part of tests, only used to release the collection, etc. 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. | |
Collections MUST not use files outside ``meta/``, ``plugins/``, ``roles/`` and ``playbooks/`` in any plugin, role, or playbook that can be called by FQCN, used from other collections, or used from user playbooks and roles. A collection must work if every file or directory is deleted from the installed collection except these directories and their contents. | |
Internal plugins, roles and playbooks (artifacts used only in testing, or only to release the collection, or only for some other internal purpose and not used externally) are exempt from this rule and may rely on files in other directories. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Implements ansible-community/community-topics#77. Once that is approved (and word-smithing has been done here), this can be merged.
ISSUE TYPE
COMPONENT NAME
collection requirements