From b37531b6a8a553dafacd9338d76734428edfacca Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Mon, 4 May 2026 16:21:20 +0300 Subject: [PATCH] collections/requirements.yml: document purpose and audience The file is not used by the playbook's standard CLI install flow (`make roles` / `just roles` only install roles via ansible-galaxy, not collections). It exists for AWX / Ansible Automation Platform users, where it is auto-detected during project sync. Without this comment, the file looks like an unused leftover and is a recurring source of confusion when discussing collection version pins (should we add one here, etc.). Documenting the actual audience makes those decisions more obvious. No functional change. Co-Authored-By: Claude Opus 4.7 (1M context) --- collections/requirements.yml | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/collections/requirements.yml b/collections/requirements.yml index 483ed156a..353ad187b 100644 --- a/collections/requirements.yml +++ b/collections/requirements.yml @@ -1,4 +1,20 @@ --- +# This file is not used by the playbook's standard CLI installation flow. +# Roles are pulled via `make roles` / `just roles`, which call +# `ansible-galaxy install -r requirements.yml -p roles/galaxy/`. +# Collections are not installed by that command, and the playbook relies +# on whatever `community.*` collections ship with the user's `ansible` +# package (which has been recent enough for years). +# +# This file exists for AWX / Ansible Automation Platform users, which +# auto-detect `collections/requirements.yml` during project sync and +# install the listed collections. See: +# https://github.com/spantaleev/matrix-docker-ansible-deploy/commit/87a2240dc +# +# CLI users do not need to install anything from this file. If you are +# using AWX and a collection version below the floor declared here is +# present, AWX will upgrade it. + collections: - name: community.general - name: community.docker