Unify release scripts, document pre-releases

.gitignore

@@ -1,14 +1,17 @@
-# Flower files
+# Flower
 .flower_ops
 data/
 doc/source/api_documentation
 doc/source/_build
 flwr_logs
 .cache
 
-# Datasets
-cifar-10-python.tar.gz
-cifar-10-batches-py
+# Flower Examples
+examples/**/dataset/**
+examples/**/dev/*.sh
+
+# Flower Baselines
+baselines/datasets/leaf
 
 # macOS
 .DS_Store
@@ -154,9 +157,3 @@ dmypy.json
 # Poetry
 poetry.lock
 *.pkl
-
-# Examples
-examples/**/dataset/**
-
-# Datasets
-baselines/datasets/leaf

dev/build.sh

@@ -1,4 +1,20 @@
 #!/bin/bash
+
+# Copyright 2022 Adap GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+
 set -e
 cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"/../
 

dev/publish-nightly.sh

@@ -15,6 +15,9 @@
 # limitations under the License.
 # ==============================================================================
 
+set -e
+cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"/../
+
 # This script will build and publish a nightly release of Flower under the condition
 # that at least one commit was made in the last 24 hours.
 # It will rename the the package name in the pyproject.toml to from "flwr" to "flwr-nightly".

dev/publish.sh

@@ -1,4 +1,20 @@
 #!/bin/bash
+
+# Copyright 2022 Adap GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+
 set -e
 cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"/../
 

dev/release.sh

@@ -1,8 +1,23 @@
 #!/bin/bash
+
+# Copyright 2022 Adap GmbH. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+
 set -e
 cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"/../
 
-
 rm -rf dist
-poetry build
-poetry publish
+./dev/build.sh
+./dev/publish.sh

doc/source/release-process.rst

@@ -25,3 +25,39 @@ Create a pull request which contains the following changes:
 3. Add a new :code:`Unreleased` section in `changelog.rst`.
 
 Merge the pull request on the same day (i.e., before a new nighly release gets published to PyPI).
+
+Publishing a pre-release
+------------------------
+
+Pre-release naming
+~~~~~~~~~~~~~~~~~~
+
+PyPI supports pre-releases (alpha, beta, release candiate). Pre-releases MUST use one of the following naming patterns:
+
+- Alpha: ``MAJOR.MINOR.PATCHaN``
+- Beta: ``MAJOR.MINOR.PATCHbN``
+- Release candiate (RC): ``MAJOR.MINOR.PATCHrcN``
+
+Examples include:
+
+- ``1.0.0a0``
+- ``1.0.0b0``
+- ``1.0.0rc0``
+- ``1.0.0rc1``
+
+This is in line with PEP-440 and the recommendations from the Python Packaging
+Authority (PyPA):
+
+- `PEP-440 <https://peps.python.org/pep-0440/>`_
+- `PyPA Choosing a versioning scheme <https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#choosing-a-versioning-scheme>`_
+
+Note that the approach defined by PyPA is not compatible with SemVer 2.0.0 spec, for details consult the `Semantic Versioning Specification <https://semver.org/spec/v2.0.0.html#spec-item-11>`_ (specifically item 11 on precedence).
+
+Pre-release classification
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Should the next pre-release be called alpha, beta, or release candidate?
+
+- RC: feature complete, no known issues (apart from issues that are classified as "won't fix" for the next stable release) - if no issues surface this will become the next stable release
+- Beta: feature complete, allowed to have known issues
+- Alpha: not feature complete, allowed to have known issues