From aadd2dca8ee26e8853622199264782e67d259c35 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Mon, 21 Jul 2025 20:42:54 +0200 Subject: [PATCH] Update removal/readd processes to refer to the documentation of ansible-build-data (#2821) * Update removal/readd processes to refer to the documentation of ansible-build-data. * Fix typo. --- .../collection_package_removal.rst | 26 ++++++++++--------- 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/docsite/rst/community/collection_contributors/collection_package_removal.rst b/docs/docsite/rst/community/collection_contributors/collection_package_removal.rst index 01e9da48a9..e720848032 100644 --- a/docs/docsite/rst/community/collection_contributors/collection_package_removal.rst +++ b/docs/docsite/rst/community/collection_contributors/collection_package_removal.rst @@ -35,8 +35,11 @@ The general process of removing a collection follows these steps: Announcing upcoming removal --------------------------- -#. Announce upcoming removal in the Ansible changelog (``https://github.com/ansible-community/ansible-build-data/blob/main//changelog.yaml``). - See the following link for an `example on how to add changelog entries to the Ansible changelog `__. +#. `Announce upcoming removal in the Ansible changelog + `_. + Note that if the collection has already been deprecated, and the deprecation was canceled / the collection was re-added, + a `slightly different procedure has to be followed + `_. #. Announce upcoming removal in the collection's issue tracker if possible. #. Announce upcoming removal in The Bullhorn. @@ -45,23 +48,22 @@ Announcing upcoming removal Removing a collection --------------------- -To remove a collection from Ansible version X.0.0: - -#. Remove from ``ansible.in`` (``https://github.com/ansible-community/ansible-build-data/blob/main//ansible.in``). -#. Remove from ``collection-meta.yaml`` (``https://github.com/ansible-community/ansible-build-data/blob/main//collection-meta.yaml``). -#. Document actual removal for the first/next alpha of Ansible X.0.0 in the Ansible changelog (``https://github.com/ansible-community/ansible-build-data/blob/main//changelog.yaml``). - See the following link for an `example on how to add changelog entries to the Ansible changelog `__. +To remove a collection from Ansible version X.0.0, `follow the procedure documented in ansible-build-data +`_ .. _readd_collection: Re-adding a collection ---------------------- -Re-adding a collection to Ansible works the same as adding it in the first place. See the `process of adding a new collection to Ansible `_ for reference. +There are two processes: -#. Re-add collection to ``ansible.in`` (``https://github.com/ansible-community/ansible-build-data/blob/main//ansible.in``). -#. Re-add collection to ``collection-meta.yaml`` (``https://github.com/ansible-community/ansible-build-data/blob/main//collection-meta.yaml``). -#. If the removal was announced in the Ansible changelog for a version that has not yet been released (``https://github.com/ansible-community/ansible-build-data/blob/main//changelog.yaml``), remove the announcement. +* If the collection was not yet removed from ``ansible.in`` or no pre-release has been made for that Ansible version, + look at `Cancel deprecation of a collection + `_. +* If the collection has already been removed from ``ansible.in`` and a pre-release has already been made for that Ansible version, + look at `Re-adding a already removed collection + `_. Broken collections ==================