Merge pull request #1 from herve4m/herve4m/cleanup

Fix tests (integation, lint, and pre-commit) and regenerate documentation

.github/workflows/ansible-integration.yml

@@ -12,21 +12,21 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          path: ansible_collections/herve4m/quay
+          path: ansible_collections/infra/quay_configuration
 
       - name: Set access rights to Quay configuration file
         run: |
           chmod 777 quay-config
           chmod 666 quay-config/config.yaml
-        working-directory: ./ansible_collections/herve4m/quay/tests
+        working-directory: ./ansible_collections/infra/quay_configuration/tests
 
       - name: Deploy Quay
         run: docker-compose up -d
-        working-directory: ./ansible_collections/herve4m/quay/tests
+        working-directory: ./ansible_collections/infra/quay_configuration/tests
 
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: '3.12'
 
       - name: Install required packages
         run: pip install -Iv ansible
@@ -42,15 +42,15 @@ jobs:
         run: >
           ansible-test integration -v --color --continue-on-error --diff
           --requirements --coverage
-        working-directory: ./ansible_collections/herve4m/quay
+        working-directory: ./ansible_collections/infra/quay_configuration
 
       - name: Generate coverage report
         run: >
           ansible-test coverage xml -v --requirements --group-by command
           --group-by version
-        working-directory: ./ansible_collections/herve4m/quay
+        working-directory: ./ansible_collections/infra/quay_configuration
 
-      # See the repots at https://codecov.io/gh/herve4m/quay
+      # See the repots at https://codecov.io/gh/infra/quay_configuration
       - uses: codecov/codecov-action@v4
         with:
           fail_ci_if_error: false

.github/workflows/ansible-sanity.yml

@@ -19,18 +19,18 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: '3.11'
+          python-version: '3.12'
 
       - name: Install required packages
         run: pip install -Iv ansible
 
       - uses: actions/checkout@v4
         with:
-          path: ansible_collections/herve4m/quay
+          path: ansible_collections/infra/quay_configuration
 
       - name: Run sanity tests
         run: >
           ANSIBLE_TEST_PREFER_PODMAN=1 ansible-test sanity
           --docker default -v --color
-        working-directory: ./ansible_collections/herve4m/quay
+        working-directory: ./ansible_collections/infra/quay_configuration
 ...

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: end-of-file-fixer
         exclude: ^docs/
@@ -14,7 +14,7 @@ repos:
         types:
           - yaml
   - repo: https://github.com/ansible/ansible-lint.git
-    rev: v24.2.3
+    rev: v24.7.0
     hooks:
       - id: ansible-lint
         types:
@@ -30,7 +30,7 @@ repos:
         types:
           - python
   - repo: https://github.com/pycqa/flake8
-    rev: 7.0.0
+    rev: 7.1.0
     hooks:
       - id: flake8
         name: flake8

CHANGELOG.rst

@@ -4,6 +4,19 @@ Quay Container Registry Collection Release Notes
 
 .. contents:: Topics
 
+v2.0.0
+======
+
+Release Summary
+---------------
+
+Renaming the ``herve4m.quay`` collection to ``infra.quay_configuration``, and moving the developments to a new GitHub repository (https://github.com/redhat-cop/quay_configuration).
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- The name of the collection changes to ``infra.quay_configuration``.
+
 v1.3.0
 ======
 

changelogs/changelog.yaml

@@ -150,11 +150,13 @@ releases:
   0.1.2:
     changes:
       minor_changes:
-      - Add the ``infra.quay_configuration.quay`` module defaults group. To avoid repeating common
-        parameters, such as ``quay_host`` or ``quay_token``, in each task, you can
-        define these common module parameters at the top of your play, in the ``module_defaults``
-        section, under the ``group/infra.quay_configuration.quay`` subsection.
-      release_summary: Adding the ``infra.quay_configuration.quay`` module defaults group.
+      - Add the ``infra.quay_configuration.quay`` module defaults group. To avoid
+        repeating common parameters, such as ``quay_host`` or ``quay_token``, in each
+        task, you can define these common module parameters at the top of your play,
+        in the ``module_defaults`` section, under the ``group/infra.quay_configuration.quay``
+        subsection.
+      release_summary: Adding the ``infra.quay_configuration.quay`` module defaults
+        group.
     fragments:
     - 021-v0.1.2-summary.yml
     release_date: '2022-10-13'
@@ -221,3 +223,14 @@ releases:
         name: quay_docker_config
         namespace: null
     release_date: '2024-05-07'
+  2.0.0:
+    changes:
+      breaking_changes:
+      - The name of the collection changes to ``infra.quay_configuration``.
+      release_summary: 'Renaming the ``herve4m.quay`` collection to ``infra.quay_configuration``,
+        and moving the developments to a new GitHub repository (https://github.com/redhat-cop/quay_configuration).
+
+        '
+    fragments:
+    - PR1-v2.0.0-summary.yaml
+    release_date: '2024-07-26'

docs/environment_variables.rst

@@ -2,7 +2,7 @@
 :orphan:
 
 .. meta::
-  :antsibull-docs: 2.11.0
+  :antsibull-docs: 2.12.0
 
 .. _list_of_collection_env_vars:
 

docs/index.rst

@@ -1,15 +1,15 @@
 
 
 .. meta::
-  :antsibull-docs: 2.11.0
+  :antsibull-docs: 2.12.0
 
 
 .. _plugins_in_infra.quay_configuration:
 
-infra.quay_configuration
-============
+Infra.Quay_Configuration
+========================
 
-Collection version 1.3.0
+Collection version 2.0.0
 
 .. contents::
    :local:
@@ -20,9 +20,10 @@ Description
 
 Ansible modules to manage Quay Container Registry installations
 
-**Author:**
+**Authors:**
 
 * Hervé Quatremain <[email protected]>
+* Tom Page <[email protected]>
 
 **Supported ansible-core versions:**
 

docs/quay_api_token_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.11.0
+  :antsibull-docs: 2.12.0
 
 .. Anchors
 
@@ -18,25 +18,25 @@
 .. Title
 
 infra.quay_configuration.quay_api_token module -- Create OAuth access tokens for accessing the Quay Container Registry API
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 .. Collection note
 
 .. note::
-    This module is part of the `infra.quay_configuration collection <https://galaxy.ansible.com/ui/repo/published/herve4m/quay/>`_ (version 1.3.0).
+    This module is part of the `infra.quay_configuration collection <https://galaxy.ansible.com/ui/repo/published/infra/quay_configuration/>`_ (version 2.0.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
 
-    To install it, use: :code:`ansible-galaxy collection install infra.quay_configuration`.
+    To install it, use: :code:`ansible-galaxy collection install infra.quay\_configuration`.
 
     To use it in a playbook, specify: :code:`infra.quay_configuration.quay_api_token`.
 
 .. version_added
 
 .. rst-class:: ansible-version-added
 
-New in infra.quay_configuration 0.0.12
+New in infra.quay\_configuration 0.0.12
 
 .. contents::
    :local:
@@ -90,7 +90,7 @@ Parameters
     </div></td>
     <td><div class="ansible-option-cell">
       <p>The client ID associated with the OAuth application to use for generating the OAuth access token.</p>
-      <p>See the <a href='../../herve4m/quay/quay_application_module.html' class='module'>infra.quay_configuration.quay_application</a> module to create an application object and to retrieve the associated client ID.</p>
+      <p>See the <a href='../../infra/quay_configuration/quay_application_module.html' class='module'>infra.quay_configuration.quay_application</a> module to create an application object and to retrieve the associated client ID.</p>
     </div></td>
   </tr>
   <tr class="row-odd">

docs/quay_application_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.11.0
+  :antsibull-docs: 2.12.0
 
 .. Anchors
 
@@ -18,25 +18,25 @@
 .. Title
 
 infra.quay_configuration.quay_application module -- Manage Quay Container Registry applications
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 .. Collection note
 
 .. note::
-    This module is part of the `infra.quay_configuration collection <https://galaxy.ansible.com/ui/repo/published/herve4m/quay/>`_ (version 1.3.0).
+    This module is part of the `infra.quay_configuration collection <https://galaxy.ansible.com/ui/repo/published/infra/quay_configuration/>`_ (version 2.0.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
 
-    To install it, use: :code:`ansible-galaxy collection install infra.quay_configuration`.
+    To install it, use: :code:`ansible-galaxy collection install infra.quay\_configuration`.
 
     To use it in a playbook, specify: :code:`infra.quay_configuration.quay_application`.
 
 .. version_added
 
 .. rst-class:: ansible-version-added
 
-New in infra.quay_configuration 0.0.1
+New in infra.quay\_configuration 0.0.1
 
 .. contents::
    :local:

docs/quay_default_perm_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.11.0
+  :antsibull-docs: 2.12.0
 
 .. Anchors
 
@@ -18,25 +18,25 @@
 .. Title
 
 infra.quay_configuration.quay_default_perm module -- Manage Quay Container Registry default repository permissions
-++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 .. Collection note
 
 .. note::
-    This module is part of the `infra.quay_configuration collection <https://galaxy.ansible.com/ui/repo/published/herve4m/quay/>`_ (version 1.3.0).
+    This module is part of the `infra.quay_configuration collection <https://galaxy.ansible.com/ui/repo/published/infra/quay_configuration/>`_ (version 2.0.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
 
-    To install it, use: :code:`ansible-galaxy collection install infra.quay_configuration`.
+    To install it, use: :code:`ansible-galaxy collection install infra.quay\_configuration`.
 
     To use it in a playbook, specify: :code:`infra.quay_configuration.quay_default_perm`.
 
 .. version_added
 
 .. rst-class:: ansible-version-added
 
-New in infra.quay_configuration 0.0.1
+New in infra.quay\_configuration 0.0.1
 
 .. contents::
    :local:

docs/quay_docker_config_filter.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.11.0
+  :antsibull-docs: 2.12.0
 
 .. Anchors
 
@@ -18,25 +18,25 @@
 .. Title
 
 infra.quay_configuration.quay_docker_config filter -- Build a Docker configuration in JSON format
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 .. Collection note
 
 .. note::
-    This filter plugin is part of the `infra.quay_configuration collection <https://galaxy.ansible.com/ui/repo/published/herve4m/quay/>`_ (version 1.3.0).
+    This filter plugin is part of the `infra.quay_configuration collection <https://galaxy.ansible.com/ui/repo/published/infra/quay_configuration/>`_ (version 2.0.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
 
-    To install it, use: :code:`ansible-galaxy collection install infra.quay_configuration`.
+    To install it, use: :code:`ansible-galaxy collection install infra.quay\_configuration`.
 
     To use it in a playbook, specify: :code:`infra.quay_configuration.quay_docker_config`.
 
 .. version_added
 
 .. rst-class:: ansible-version-added
 
-New in infra.quay_configuration 1.3.0
+New in infra.quay\_configuration 1.3.0
 
 .. contents::
    :local:

docs/quay_docker_token_module.rst

@@ -7,7 +7,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.11.0
+  :antsibull-docs: 2.12.0
 
 .. Anchors
 
@@ -18,25 +18,25 @@
 .. Title
 
 infra.quay_configuration.quay_docker_token module -- Manage tokens for accessing Quay Container Registry repositories
-+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 .. Collection note
 
 .. note::
-    This module is part of the `infra.quay_configuration collection <https://galaxy.ansible.com/ui/repo/published/herve4m/quay/>`_ (version 1.3.0).
+    This module is part of the `infra.quay_configuration collection <https://galaxy.ansible.com/ui/repo/published/infra/quay_configuration/>`_ (version 2.0.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
 
-    To install it, use: :code:`ansible-galaxy collection install infra.quay_configuration`.
+    To install it, use: :code:`ansible-galaxy collection install infra.quay\_configuration`.
 
     To use it in a playbook, specify: :code:`infra.quay_configuration.quay_docker_token`.
 
 .. version_added
 
 .. rst-class:: ansible-version-added
 
-New in infra.quay_configuration 0.0.11
+New in infra.quay\_configuration 0.0.11
 
 .. contents::
    :local: