Skip to content

Commit

Permalink
remove the version update as this is now done by tags
Browse files Browse the repository at this point in the history
  • Loading branch information
niccokunzmann committed Sep 28, 2024
1 parent 17dba94 commit 4673e04
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions docs/maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,7 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app

1. Check that the ``CHANGES.rst`` is up to date with the `latest merged pull requests <https://github.com/collective/icalendar/pulls?q=is%3Apr+is%3Amerged>`__
and the version you want to release is correctly named.
2. Change the ``__version__`` variable in

- the ``src/icalendar/__init__.py`` file and
3. Create a commit on the ``release`` branch (or equivalent) to release this version.
2. Create a commit on the ``release`` branch (or equivalent) to release this version.

.. code-block:: bash
Expand All @@ -75,17 +72,17 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app
git add CHANGES.rst src/icalendar/__init__.py docs/install.rst
git commit -m"version 5.0.0"
4. Push the commit and `create a pull request <https://github.com/collective/icalendar/compare?expand=1>`__
3. Push the commit and `create a pull request <https://github.com/collective/icalendar/compare?expand=1>`__
Here is an `example pull request #457 <https://github.com/collective/icalendar/pull/457>`__.

.. code-block:: bash
git push -u origin release
5. See if the `CI-tests <https://github.com/collective/icalendar/actions>`_ are running on the pull request.
4. See if the `CI-tests <https://github.com/collective/icalendar/actions>`_ are running on the pull request.
If they are not running, no new release can be issued.
If the tests are running, merge the pull request.
6. Clean up behind you!
5. Clean up behind you!

.. code-block:: bash
Expand All @@ -94,7 +91,7 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app
git branch -d release
git push -d origin release
7. Create a tag for the release and see if the `CI-tests`_ are running.
6. Create a tag for the release and see if the `CI-tests`_ are running.

.. code-block:: bash
Expand All @@ -103,15 +100,15 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app
git tag v5.0.0
git push upstream v5.0.0 # could be origin or whatever reference
8. Once the tag is pushed and its `CI-tests`_ are passing, maintainers will get an e-mail::
7. Once the tag is pushed and its `CI-tests`_ are passing, maintainers will get an e-mail::

Subject: Deployment review in collective/icalendar

tests: PyPI is waiting for your review

9. If the release is approved by a maintainer. It will be pushed to `PyPI`_.
8. If the release is approved by a maintainer. It will be pushed to `PyPI`_.
If that happens, notify the issues that were fixed about this release.
10. Copy this to the start of ``CHANGES.rst``::
9. Copy this to the start of ``CHANGES.rst``::

5.0.2 (unreleased)
------------------
Expand All @@ -132,7 +129,7 @@ However, only people with ``PyPI environment access for GitHub Actions`` can app

- ...

11. Push the new CHANGELOG so it is used for future changes.
10. Push the new CHANGELOG so it is used for future changes.

.. code-block:: bash
Expand Down

0 comments on commit 4673e04

Please sign in to comment.