Project structure

Folders

automation

• Scripts that CI will run to test the collection and do builds of RPM and tars.
• Lists of packages necessary for the CI to run it.

changelogs

• Changelogs for ansible which will be shown on ansible release.
• Fragments from which the changelogs are being created.

examples

• Longer examples than in the module with more specific use like filters.

meta

• List for action groups (PR)

plugins

• Contains the main logic of the collection
  • modules
  • module_utils
  • filters
  • inventory plugin
  • doc_fragments

tests

• Contains ignore files for CI when running the ansible tests.

Files

CHANGELOG.rst

• This file is automatically being updated from the changelogs folder when doing the release.

automation.yaml

• Contains a list on which environments should CI run.

bindep.txt

• List of required rpm dependencies which will be installed in the container for ansible-builder.

build.sh

• The script which is used to
  • Rename @NAMESPACE@ and @NAME@ to the correct name
  • Create spec file from spec.in
  • Create tarball for the build
• Contains the install script for RPM

galaxy.yml

• Contains necessary information for galaxy and automation hub

ovirt-ansible-collection.spec.in

• It is a spec file from which the rpm will be built.
• The .in will be removed when doing CI build, currently, it contains a few variables in format @VARNAME@ which CI will replace.

requirements.txt

• List of required pypi dependencies which will be installed in the container for ansible-builder.