mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Release 0.2.0 of community.general (#546 )

* Comment out dead documentation link.

* Move changelog into root.

* Link to generated changelog in README.

* Fix changelog entry categories (bugfixes -> security_fixes).

* Add release summary.

* Geneate changelog.

* Add basic release information.

* Require Ansible(-base) 2.9.10 or newer.

Needed for deprecation syntax support.

2020-06-20 12:49:50 +02:00

2.9 KiB

Raw Blame History

Ansible Collection: community.general

This repo contains the community.general Ansible Collection.

The collection includes the modules and plugins supported by Ansible community.

Installation and Usage

Installing the Collection from Ansible Galaxy

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

Testing and Development

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_PATHS, and work on it there.

You can find more information in the developer guide for collections

Testing with `ansible-test`

See here.

Release notes

See here.

Publishing New Version

Basic instructions without release branches:

Create changelogs/fragments/<version>.yml with release_summary: section (which must be a string, not a list).
Run antsibull-changelog release --collection-flatmap yes
Make sure CHANGELOG.rst and changelogs/changelog.yaml are added to git, and the deleted fragments have been removed.
Tag the commit with <version>. Push changes and tag to the main repository.

More Information

TBD

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

License

GNU General Public License v3.0 or later

See LICENSE to see the full text.

2.9 KiB Raw Blame History