Skip to content

Commit 3df0624

Browse files
russozpatchback[bot]
authored andcommitted
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)
1 parent 3ff2f55 commit 3df0624

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

docs/docsite/rst/community/collection_contributors/collection_release_without_branches.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Since no release branches are used, this section does not distinguish between re
99
.. contents::
1010
:local:
1111

12+
.. _release_planning_announcement:
13+
1214
Release planning and announcement
1315
----------------------------------
1416

@@ -69,7 +71,7 @@ Generating the changelog
6971
7072
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.
7173

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``.
7375

7476
4. Verify that the ``CHANGELOG.rst`` looks as expected.
7577

@@ -102,14 +104,16 @@ Publish the collection
102104
git tag -a NEW_VERSION -m "comment here" # the comment can be, for example, "community.postgresql: 1.2.0"
103105
git push upstream NEW_VERSION
104106
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).
106108

107109
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.
108110

109111
3. Update the version in the ``galaxy.yml`` file to the next **expected** version. Add, commit, and push to the ``upstream``'s default branch.
110112

111113
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``.
112114

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/>`_.
114117

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,
119+
announce the release in there as well.

docs/docsite/rst/community/collection_contributors/collection_releasing.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ To prepare for a release, a collection must have:
2929

3030
See :ref:`including_collection_ansible` if you plan on adding a new collection to the Ansible package.
3131

32-
.. note::
33-
32+
.. note::
33+
3434
Your collection must pass ``ansible-test sanity`` tests. See :ref:`testing_collections` for details.
3535

3636

@@ -71,7 +71,7 @@ Before releasing, verify the following for your changelogs:
7171
Options for releasing a collection
7272
-----------------------------------
7373

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.
7575

7676
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.
7777

0 commit comments

Comments
 (0)