3e9a6acff7
* Improvements in module_helper - added `ModuleHelperException` to handle problems specific to ModuleHelper - updated `module_fails_on_exception` for `ModuleHelperException` - `StateMixin`: composed names of state methods are now calculated instead of fixed. - `CmdMixin`: added `run_command_fixed_options` to pass some parameters on every call * Improvements in module_helper - Named deprecations: ability to declare a `dict` of deprecations indexed by names, allowing module maintainer to trigger them by those names, and also allowing the module user to acknowledge them in a similar way. - Adding `ack_named_deprecations` to module's `argument_spec` when they exist. - Providing doc fragment for `ack_named_deprecations`. - Added method `__quit_module__` providing a hook for code that needs to be run when quitting the module. - Created convenience classes combining `ModuleHelper`, `StateMixin`, `CmdMixin`. * fixed validation * fixed validation * changelog fragment * Apply suggestions from code review Co-authored-by: Felix Fontein <felix@fontein.de> * Improvement on Named Deprecations Per the comments in PR, we want to expose a call to a ``deprecate`` method on the module code, so that pylint can properly perform its static analysis on deprecations. This prompted a revamp of the named deprecation feature. * Use .get() instead of [] for the param to ack named deprecations. * Changes from suggestions in the PR * removed named deprecations * Update changelogs/fragments/1480-module-helper-improvements.yml Co-authored-by: Felix Fontein <felix@fontein.de> * Update plugins/module_utils/module_helper.py Co-authored-by: Felix Fontein <felix@fontein.de> |
||
|---|---|---|
| .azure-pipelines | ||
| .github | ||
| changelogs | ||
| meta | ||
| plugins | ||
| scripts | ||
| tests | ||
| .gitignore | ||
| CHANGELOG.rst | ||
| COPYING | ||
| galaxy.yml | ||
| README.md | ||
| shippable.yml | ||
Community General Collection
This repo contains the community.general Ansible Collection. The collection includes many modules and plugins supported by Ansible community which are not part of more specialized community collections.
You can find documentation for this collection on the Ansible docs site.
Tested with Ansible
Tested with the current Ansible 2.9 and 2.10 releases and the current development version of Ansible. Ansible versions before 2.9.10 are not supported.
External requirements
Some modules and plugins require external libraries. Please check the requirements for each plugin or module you use in the documentation to find out which requirements are needed.
Included content
Please check the included content on the Ansible Galaxy page for this collection or the documentation on the Ansible docs site.
Using this collection
Before using the General community collection, you need to install the collection with the ansible-galaxy CLI:
ansible-galaxy collection install community.general
You can also include it in a requirements.yml file and install it via ansible-galaxy collection install -r requirements.yml using the format:
collections:
- name: community.general
See Ansible Using collections for more details.
Contributing to this collection
If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured COLLECTIONS_PATH, and work on it there.
For example, if you are working in the ~/dev directory:
cd ~/dev
git clone git@github.com:ansible-collections/community.general.git collections/ansible_collections/community/general
export COLLECTIONS_PATH=$(pwd)/collections:$COLLECTIONS_PATH
You can find more information in the developer guide for collections, and in the Ansible Community Guide.
Running tests
See here.
Communication
We have a dedicated Working Group for Ansible development.
You can find other people interested on the following Freenode IRC channels -
#ansible- For general use questions and support.#ansible-devel- For discussions on developer topics and code related to features or bugs.#ansible-community- For discussions on community topics and community meetings.
For more information about communities, meetings and agendas see Community Wiki.
For more information about communication
Publishing New Version
Basic instructions without release branches:
- Create
changelogs/fragments/<version>.ymlwithrelease_summary:section (which must be a string, not a list). - Run
antsibull-changelog release --collection-flatmap yes - Make sure
CHANGELOG.rstandchangelogs/changelog.yamlare added to git, and the deleted fragments have been removed. - Tag the commit with
<version>. Push changes and tag to the main repository.
Release notes
See the changelog.
Roadmap
See this issue for information on releasing, versioning and deprecation.
In general, we plan to release a major version every six months, and minor versions every two months. Major versions can contain breaking changes, while minor versions only contain new features and bugfixes.
More information
- Ansible Collection overview
- Ansible User guide
- Ansible Developer guide
- Ansible Community code of conduct
Licensing
GNU General Public License v3.0 or later.
See COPYING to see the full text.