Skip to content

Commit aadd2dc

Browse files
authored
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.
1 parent 1976c8e commit aadd2dc

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

docs/docsite/rst/community/collection_contributors/collection_package_removal.rst

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,11 @@ The general process of removing a collection follows these steps:
3535
Announcing upcoming removal
3636
---------------------------
3737

38-
#. Announce upcoming removal in the Ansible changelog (``https://github.com/ansible-community/ansible-build-data/blob/main/<X>/changelog.yaml``).
39-
See the following link for an `example on how to add changelog entries to the Ansible changelog <https://github.com/ansible-community/ansible-build-data/pull/68/files>`__.
38+
#. `Announce upcoming removal in the Ansible changelog
39+
<https://ansible.readthedocs.io/projects/ansible-build-data/policies/#announce-removal-of-a-collection-deprecation>`_.
40+
Note that if the collection has already been deprecated, and the deprecation was canceled / the collection was re-added,
41+
a `slightly different procedure has to be followed
42+
<https://ansible.readthedocs.io/projects/ansible-build-data/policies/#re-deprecating-a-collection>`_.
4043
#. Announce upcoming removal in the collection's issue tracker if possible.
4144
#. Announce upcoming removal in The Bullhorn.
4245

@@ -45,23 +48,22 @@ Announcing upcoming removal
4548
Removing a collection
4649
---------------------
4750

48-
To remove a collection from Ansible version X.0.0:
49-
50-
#. Remove from ``ansible.in`` (``https://github.com/ansible-community/ansible-build-data/blob/main/<X>/ansible.in``).
51-
#. Remove from ``collection-meta.yaml`` (``https://github.com/ansible-community/ansible-build-data/blob/main/<X>/collection-meta.yaml``).
52-
#. 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/<X>/changelog.yaml``).
53-
See the following link for an `example on how to add changelog entries to the Ansible changelog <https://github.com/ansible-community/ansible-build-data/pull/68/files>`__.
51+
To remove a collection from Ansible version X.0.0, `follow the procedure documented in ansible-build-data
52+
<https://ansible.readthedocs.io/projects/ansible-build-data/policies/#removing-a-collection>`_
5453

5554
.. _readd_collection:
5655

5756
Re-adding a collection
5857
----------------------
5958

60-
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 <https://github.com/ansible-community/ansible-build-data/#adding-a-new-collection>`_ for reference.
59+
There are two processes:
6160

62-
#. Re-add collection to ``ansible.in`` (``https://github.com/ansible-community/ansible-build-data/blob/main/<X>/ansible.in``).
63-
#. Re-add collection to ``collection-meta.yaml`` (``https://github.com/ansible-community/ansible-build-data/blob/main/<X>/collection-meta.yaml``).
64-
#. 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/<X>/changelog.yaml``), remove the announcement.
61+
* If the collection was not yet removed from ``ansible.in`` or no pre-release has been made for that Ansible version,
62+
look at `Cancel deprecation of a collection
63+
<https://ansible.readthedocs.io/projects/ansible-build-data/policies/#cancel-deprecation-of-a-collection>`_.
64+
* If the collection has already been removed from ``ansible.in`` and a pre-release has already been made for that Ansible version,
65+
look at `Re-adding a already removed collection
66+
<https://ansible.readthedocs.io/projects/ansible-build-data/policies/#re-adding-a-already-removed-collection>`_.
6567

6668
Broken collections
6769
==================

0 commit comments

Comments
 (0)