chore: release 0.28.0 (#320)

Signed-off-by: ThibaultFy <[email protected]>

Author: ThibaultFy

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.28.0]
+
 - add token management page guide ([#312](https://github.com/Substra/substra-documentation/pull/312))
 - Update Iris example with the changes implied by [SubstraFL #120](https://github.com/Substra/substrafl/pull/120) compute plan builder ([#313](https://github.com/Substra/substra-documentation/pull/313))
 - Add caution for frontend cookies when several backends in local ([#308](https://github.com/Substra/substra-documentation/pull/308))

docs/source/additional/release.rst

@@ -28,10 +28,45 @@ This is an overview of the main changes, please have a look at the changelog of
 - `backend changelog <https://github.com/Substra/substra-backend/blob/main/CHANGELOG.md>`__
 - `orchestrator changelog <https://github.com/Substra/orchestrator/blob/main/CHANGELOG.md>`__
 
+Substra 0.28.0 --- 2023-06-14
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+**SubstraFL**:
+
+- On how to **decrease** Docker image size to accelerate the compute plan speed:
+
+  - Add ``excluded_paths`` and ``excluded_regex`` parameters to the ``Dependency`` object to exclude file when building the ``Dependency`` object. Defaults are provided to avoid creating large Docker images.
+
+- On **Federated Analytics** and creating **custom FL strategies**:
+
+  - Add ``ComputePlanBuilder`` base class to define which method are needed to implement a custom strategy in SubstraFL. These methods are ``build_compute_plan``, ``load_local_states``and ``save_local_states``.
+  - **BREAKING CHANGE**: rename ``build_graph`` to ``build_compute_plan``.
+  - **BREAKING CHANGE**: move ``schema.py`` to ``strategy/schema.py``.
+
+.. code-block:: python
+
+  from substrafl.schemas import FedAvgSharedState
+  # Become
+  from substrafl.strategies.schemas import FedAvgSharedState
+
+**Substra**:
+
+- Fix issue on the ordering when sorting assert (for instance on the ``list_task()`` function).
+
+**Web application**:
+
+- Fix issue where hyper-parameters were not nicely shown when their names was too big.
+- The API tokens management has now a **new page** supporting multiple token per user - see - `documentation <https://docs.substra.org/en/latest/documentation/api_tokens_generation.html>`__.
+- Reset the selected Compute Plan after a logout.
+
+**Operations**:
+
+- Substra backend and orchestrator can now use **external database** rather having to use the one packaged as a subchart.
+
 Substra 0.27.0 --- 2023-05-11
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-SubstraFL:
+**SubstraFL**:
 
 - **BREAKING CHANGE**: SubstraFL used to create one task per metric. Now all metrics are executed into a single task. This will lead to less tasks for a given CP and will improve compute time.
 - **BREAKING CHANGE**: Metrics are now given as ``metric_functions`` and not as ``metric_key``. The functions given as metric functions to test data nodes are automatically registered in a new Substra function by SubstraFL.
@@ -93,12 +128,12 @@ to:
 - Enforce **kwargs** for functions with more than 3 parameters.
 - Add the **Federated Principal Component Analysis strategy**.
 
-Substra
+**Substra**:
 
 - Substra Clients can now be configured using environment variables or a configuration Yaml file.
 - **BREAKING CHANGE**: default backend type for Client is now ``subprocess``.
 
-Front-end:
+**Web application**:
 
 - Display function name for each task in workflow & tasks table.
 - Better performances for workflow.

docs/source/additional/releases.yaml

@@ -9,6 +9,44 @@ components: # for table headers
   - substra-tests
 
 releases:
+  - version: 0.28.0
+    components:
+      substrafl:
+        version: 0.37.0
+        link: https://github.com/Substra/substrafl/releases/tag/0.37.0
+      substra:
+        version: 0.45.0
+        link: https://github.com/Substra/substra/releases/tag/0.45.0
+      substra-tools:
+        version: 0.20.0
+        link: https://github.com/Substra/substra-tools/releases/tag/0.20.0
+      substra-backend:
+        version: 0.38.0
+        link: https://github.com/Substra/substra-backend/releases/tag/0.38.0
+        helm:
+          version: 22.5.1
+          link: https://artifacthub.io/packages/helm/substra/substra-backend/22.5.1
+      orchestrator:
+        version: 0.35.0
+        link: https://github.com/Substra/orchestrator/releases/tag/0.35.0
+        helm:
+          version: 7.5.1
+          link: https://artifacthub.io/packages/helm/substra/orchestrator/7.5.1
+      substra-frontend:
+        version: 0.42.1
+        link: https://github.com/Substra/substra-frontend/releases/tag/0.42.1
+        helm:
+          version: 1.0.19
+          link: https://artifacthub.io/packages/helm/substra/substra-frontend/1.0.19
+      hlf-k8s:
+        version: 0.2.4
+        link: https://github.com/Substra/hlf-k8s/releases/tag/0.2.4
+        helm:
+          version: 10.2.4
+          link: https://artifacthub.io/packages/helm/substra/hlf-k8s/10.2.4
+      substra-tests:
+        version: 0.41.0
+        link: https://github.com/Substra/substra-tests/releases/tag/0.41.0
   - version: 0.27.0
     components:
       substrafl:

docs/source/documentation/get_performances.rst

@@ -66,4 +66,4 @@ This script will automatically end if the :code:`performance.json` file has not
 
             step = int(row["round_idx"]) if row["round_idx"] is not None else int(row["task_rank"])
 
-            log_metric(f"{row['function_name']}_{row['worker']}", row["performance"], step)
+            log_metric(f"{row['identifier']}_{row['worker']}", row["performance"], step)