Skip to content

Commit

Permalink
docs(framework:skip) Add how to release the docker images (#3539)
Browse files Browse the repository at this point in the history
Signed-off-by: Robert Steiner <robert@flower.ai>
  • Loading branch information
Robert-Steiner authored May 31, 2024
1 parent e944ac0 commit 39f995c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
Binary file added doc/source/_static/docker-ci-release.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions doc/source/contributor-how-to-release-flower.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,24 @@ The version number of a release is stated in ``pyproject.toml``. To release a ne
2. Once the changelog has been updated with all the changes, run ``./dev/prepare-release-changelog.sh v<NEW_VERSION>``, where ``<NEW_VERSION>`` is the version stated in ``pyproject.toml`` (notice the ``v`` added before it). This will replace the ``Unreleased`` header of the changelog by the version and current date, and it will add a thanking message for the contributors. Open a pull request with those changes.
3. Once the pull request is merged, tag the release commit with the version number as soon as the PR is merged: ``git tag v<NEW_VERSION>`` (notice the ``v`` added before the version number), then ``git push --tags``. This will create a draft release on GitHub containing the correct artifacts and the relevant part of the changelog.
4. Check the draft release on GitHub, and if everything is good, publish it.
5. Trigger the CI for building the Docker images.

To trigger the workflow, a collaborator must create a ``workflow_dispatch`` event in the
GitHub CI. This can be done either through the UI or via the GitHub CLI. The event requires only one
input, the Flower version, to be released.

**Via the UI**

1. Go to the ``Build docker images`` workflow `page <https://github.com/adap/flower/actions/workflows/docker-images.yml>`_.
2. Click on the ``Run workflow`` button and type the new version of Flower in the ``Version of Flower`` input field.
3. Click on the **green** ``Run workflow`` button.

.. image:: _static/docker-ci-release.png

**Via the GitHub CI**

1. Make sure you are logged in via ``gh auth login`` and that the current working directory is the root of the Flower repository.
2. Trigger the workflow via ``gh workflow run docker-images.yml -f flwr-version=<NEW_VERSION>``.

After the release
-----------------
Expand Down

0 comments on commit 39f995c

Please sign in to comment.