You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Adjustments to the Collection release process (#3342)
* Adjsutments to the Collection release process
* Adjustment from the review.
* Update docs/docsite/rst/community/collection_contributors/collection_release_without_branches.rst
* adjustments from review
(cherry picked from commit 0e3c85c)
Copy file name to clipboardExpand all lines: docs/docsite/rst/community/collection_contributors/collection_release_without_branches.rst
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,8 @@ Since no release branches are used, this section does not distinguish between re
9
9
.. contents::
10
10
:local:
11
11
12
+
.. _release_planning_announcement:
13
+
12
14
Release planning and announcement
13
15
----------------------------------
14
16
@@ -69,7 +71,7 @@ Generating the changelog
69
71
70
72
2. If the content was recently moved from another collection (for example, migrating a module from one collection to another), ensure you have all related changelog fragments in the ``changelogs/fragments`` directory. If not, copy them previously.
71
73
72
-
3. Run ``antsibull-changelog release --reload-plugins`` . This package should be installed with ``pip install antsibull-changelog``.
74
+
3. Run ``antsibull-changelog release --refresh-plugins`` . This package should be installed with ``pip install antsibull-changelog``.
73
75
74
76
4. Verify that the ``CHANGELOG.rst`` looks as expected.
75
77
@@ -102,14 +104,16 @@ Publish the collection
102
104
git tag -a NEW_VERSION -m "comment here"# the comment can be, for example, "community.postgresql: 1.2.0"
103
105
git push upstream NEW_VERSION
104
106
105
-
107
+
.. note:: Make sure the release tag is in the format X.Y.Z - Zuul will not trigger the release process otherwise (as of Dec 2025).
106
108
107
109
2. Wait until the new version is published on the collection's `Ansible Galaxy <https://galaxy.ansible.com/>`_ page. It will appear in a list of tarballs available to download.
108
110
109
111
3. Update the version in the ``galaxy.yml`` file to the next **expected** version. Add, commit, and push to the ``upstream``'s default branch.
110
112
111
113
4. Add a GitHub release for the new tag. Title should be the version and content ``See https://github.com/ansible-collections/community.xxx/blob/main/CHANGELOG.rst for all changes``.
112
114
113
-
5. Announce the release through the `Bullhorn Newsletter issue <https://forum.ansible.com/c/news/bullhorn/17>`_.
115
+
5. Announce the release in the ``#social`` :ref:`Matrix/IRC channel <communication_irc>`.
116
+
By mentioning ``@newsbot`` it will automatically go into the next edition of the `Bullhorn Newsletter issue <https://forum.ansible.com/c/news/bullhorn/>`_.
114
117
115
-
6. Announce the release in the pinned release issue/community pinboard of the collection mentioned in step 3 and in the ``community`` :ref:`Matrix/IRC channel <communication_irc>`.
118
+
6. If a pinned release issue/community pinboard of the collection such as mentioned in step 3 of the :ref:`release_planning_announcement` section is being used,
Copy file name to clipboardExpand all lines: docs/docsite/rst/community/collection_contributors/collection_releasing.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,8 +29,8 @@ To prepare for a release, a collection must have:
29
29
30
30
See :ref:`including_collection_ansible` if you plan on adding a new collection to the Ansible package.
31
31
32
-
.. note::
33
-
32
+
.. note::
33
+
34
34
Your collection must pass ``ansible-test sanity`` tests. See :ref:`testing_collections` for details.
35
35
36
36
@@ -71,7 +71,7 @@ Before releasing, verify the following for your changelogs:
71
71
Options for releasing a collection
72
72
-----------------------------------
73
73
74
-
There are several approaches on how to release a collection. If you are not aware of which approach to use, ask in the ``#ansible-community`` IRC channel or the ``community`` Matrix channel.
74
+
There are several approaches on how to release a collection. If you are not aware of which approach to use, ask in the `Ansible Forum <https://forum.ansible.com>`_ or the ``#community`` Matrix channel.
75
75
76
76
This section assumes that publishing the collection is done with `Zuul <https://github.com/ansible/project-config>`_ and that `antsibull-changelog <https://github.com/ansible-community/antsibull-changelog>`_ is used for the changelog.
0 commit comments