Ansible Collection: community.windows
The community.windows
collection includes the community plugins supported by Ansible community to help the management of Windows hosts.
Ansible version compatibility
This collection has been tested against following Ansible versions: >=2.12.
Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.
Collection Documentation
Browsing the latest collection documentation will show docs for the latest version released in the Ansible package not the latest version of the collection released on Galaxy.
Browsing the devel collection documentation shows docs for the latest version released on Galaxy.
We also separately publish latest commit collection documentation which shows docs for the latest commit in the main
branch.
If you use the Ansible package and don't update collections independently, use latest, if you install or update this collection directly from Galaxy, use devel. If you are looking to contribute, use latest commit.
Installation and Usage
Installing the Collection from Ansible Galaxy
Before using the Windows collection, you need to install it with the ansible-galaxy
CLI:
ansible-galaxy collection install community.windows
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.windows
Contributing to this collection
Currently we welcome bugfixes or feature requests to plugins in this collection but no new modules or plugins will be accepted in this collection. If you find problems, please open an issue or create a PR against the Community Windows collection repository. See Contributing to Ansible-maintained collections for details.
See Developing modules for Windows for specifics on Windows modules.
You can also join us on:
IRC - #ansible-windows
irc.libera.chat channel
See the Ansible Community Guide for details on contributing to Ansible.
Code of Conduct
This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.
ansible-test
Testing with The tests
directory contains configuration for running sanity and integration tests using ansible-test
.
You can run the collection's test suites with the commands:
ansible-test sanity --docker
ansible-test windows-integration --docker
Publishing New Version
The current process for publishing new versions of the Windows Core Collection is manual, and requires a user who has access to the community
namespace on Ansible Galaxy and Automation Hub to publish the build artifact.
- Update
galaxy.yml
with the new version for the collection. - Update the
CHANGELOG
:- Make sure you have
antsibull-changelog
installedpip install antsibull-changelog
. - Make sure there are fragments for all known changes in
changelogs/fragments
. - Add a new fragment with the header
release_summary
to give a summary on the release. - Run
antsibull-changelog release
.
- Make sure you have
- Commit the changes and wait for CI to be green
- Create a release with the tag that matches the version number
- The tag is the version number itself, and should not start with anything
- This will trigger a build and publish the collection to Galaxy
- The Zuul job progress will be listed here
After the version is published, verify it exists on the Windows Community Collection Galaxy page.
More Information
For more information about Ansible's Windows integration, join the #ansible-windows
channel on libera.chat IRC, and browse the resources in the Windows Working Group Community wiki page.
- Ansible Collection overview
- Ansible User guide
- Ansible Developer guide
- Ansible Community code of conduct
License
GNU General Public License v3.0 or later
See COPYING to see the full text.