You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
While creating the opensearch module, I missed a few step that are not documented in CONTRIBUTING.md. It would help a lot to document these steps.
Issue Type
Documentation Report
Component Name
opensearch
Ansible Version
$ ansible --version
Collection Versions
$ ansible-galaxy collection list
Configuration
$ ansible-config dump --only-changed
OS / Environment
No response
Additional Information
When a developer submits a PR for a new module:
Where to do git clone. The path and directory names are important. It should be cloned under ~/collections/ansible_collections/community/aws otherwise the local tests will fail.
How to handle a situation when the new module needs a version of boto3 and botocore which is higher than the default. Examples:
How to add the module to group/aws such that the module defaults work in the integration tests main.yml file. Add to meta/runtime.yml? If the module is not added to the group, the module is not getting the module defaults. In that case, the boto3 API fails and the error message states the region is not set (because the region was set in the main.yml file but the module is not getting the value).
What files to modify? Some of them are obvious, like creating the module and the integration tests, but changes like runtime.yml are less obvious. Maybe there are other files like list of modules, documentation, change log?
Explain difference between tiny_prefix and resource_prefix in the integration tests.
Steps by step instructions to run the sanity tests and integration tests locally.
Guideline for setting the value version_added: X.Y.Z in the new module.
Indicate the module should support check_mode.
The tests/requirements.yml file specifies dependencies such as community.crypto. These dependencies need to be manually installed before running the tests:
@sebastien-rosset I think this would be a really good addition to our documentation, however the docs for amazon.aws and community.aws live over in amazon.aws. so I've transferred this issue over to amazon.aws
If we link to these from the CONTRIBUTOR file, does this cover a lot of what's been pointed out here as problematic? (things that aren't specific to AWS collection development)...
Summary
While creating the
opensearch
module, I missed a few step that are not documented in CONTRIBUTING.md. It would help a lot to document these steps.Issue Type
Documentation Report
Component Name
opensearch
Ansible Version
$ ansible --version
Collection Versions
$ ansible-galaxy collection list
Configuration
$ ansible-config dump --only-changed
OS / Environment
No response
Additional Information
When a developer submits a PR for a new module:
~/collections/ansible_collections/community/aws
otherwise the local tests will fail.group/aws
such that the module defaults work in the integration testsmain.yml
file. Add tometa/runtime.yml
? If the module is not added to the group, the module is not getting the module defaults. In that case, the boto3 API fails and the error message states the region is not set (because theregion
was set in themain.yml
file but the module is not getting the value).runtime.yml
are less obvious. Maybe there are other files like list of modules, documentation, change log?tiny_prefix
andresource_prefix
in the integration tests.version_added: X.Y.Z
in the new module.check_mode
.The
tests/requirements.yml
file specifies dependencies such ascommunity.crypto
. These dependencies need to be manually installed before running the tests:It would be worth indicating the
tests/requirements.yml
file does not have the format expected byansible-galaxy
.Code of Conduct
The text was updated successfully, but these errors were encountered: