From c99cf08030631c091a3be0a2b39bd9999cffbf47 Mon Sep 17 00:00:00 2001 From: Richard Treier Date: Wed, 6 Dec 2023 17:15:06 +0100 Subject: [PATCH] chore: prepare release (#332) --- .env | 6 ++-- .github/ISSUE_TEMPLATE/release.md | 3 +- CHANGELOG.md | 53 ++++++++++++++++++++++++------- connector/.env | 6 ++-- gradle.properties | 2 +- 5 files changed, 51 insertions(+), 19 deletions(-) diff --git a/.env b/.env index fa25f9c0..7b73ad7d 100644 --- a/.env +++ b/.env @@ -1,4 +1,4 @@ # Config for docker-compose.yaml -BROKER_IMAGE=ghcr.io/sovity/broker-server-dev:2.0.2 -EDC_IMAGE=ghcr.io/sovity/edc-dev:6.0.0 -EDC_UI_IMAGE=ghcr.io/sovity/edc-ui:2.1.0 +BROKER_IMAGE=ghcr.io/sovity/broker-server-dev:3.0.0 +EDC_IMAGE=ghcr.io/sovity/edc-dev:7.0.0 +EDC_UI_IMAGE=ghcr.io/sovity/edc-ui:2.2.0 diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index fbd3a9da..b56e6b6b 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -1,7 +1,7 @@ --- name: Release about: Create an issue to track a release process. -title: "Release x.x.x" +title: "Release vx.x.x" labels: ["task/release", "scope/mds"] assignees: "" --- @@ -35,6 +35,7 @@ Feel free to edit this release checklist in-progress depending on what tasks nee - [ ] Create a release and re-use the changelog section as release description, and the version as title. - [ ] Check if the pipeline built the release versions in the Actions-Section (or you won't see it). - [ ] Checkout the release tag and check test the `docker-compose.yaml`. + - [ ] Ensure with a `docker ps -a` that all containers are healthy, and not `healthy: starting` or `healthy: unhealthy`. - [ ] Check the contents of the Deployment Docs Zip from the GitHub Release. - [ ] Send out a release notification E-Mail to the MDS, the MDS integrator company and the MDS operator company. - [ ] Check @jkbquabeck for an up-to-date mailing list, separated into "To" and "Cc". diff --git a/CHANGELOG.md b/CHANGELOG.md index efb02a2d..e5f1d108 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,24 +13,50 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 #### Major -- Authority Portal API: Removed data offer count endpoint in favor of new Connector Metadata Endpoint. - #### Minor -- Authority Portal API: Added new Connector Metadata endpoint that includes online status, participant ID and data offer counts. - #### Patch ### Deployment Migration Notes -- Authority Portal API: The data offer count endpoint was removed in favor of the new Connector Metadata Endpoint: `wrapper/broker/authority-portal-api/connectors`, used to be ~~``authority-portal-api/data-offer-counts``~~. - #### Compatible Versions - Broker Backend Docker Image: `ghcr.io/sovity/broker-server-ce:{{ CE_VERSION }}` - Broker UI Docker Image: `ghcr.io/sovity/edc-ui:{{ UI_VERSION }}` - Sovity EDC CE: {{ CE Release Link }} +## [v3.0.0] - 2023-06-12 + +### Overview + +EDC 0 / MDS 2.0 bugfix release, Authority Portal API Connector Metadata Endpoint. + +### Detailed Changes + +#### Major + +- Authority Portal API: Removed data offer count endpoint in favor of new Connector Metadata Endpoint. + +#### Minor + +- Bumped sovity EDC CE to `7.0.0`. +- Bumped Broker UI to `2.2.0`. +- Authority Portal API: Added new Connector Metadata endpoint that includes online status, participant ID and data offer + counts. + +### Deployment Migration Notes + +- The DAPS needs to contain the claim `referringConnector=broker` for the broker. The expected value `broker` could be overridden by + specifying a different value for `MY_EDC_PARTICIPANT_ID`. +- Authority Portal API: The data offer count endpoint was removed in favor of the new Connector Metadata + Endpoint: `wrapper/broker/authority-portal-api/connectors`, used to be ~~``authority-portal-api/data-offer-counts``~~. + +#### Compatible Versions + +- Broker Backend Docker Image: `ghcr.io/sovity/broker-server-ce:3.0.0` +- Broker UI Docker Image: `ghcr.io/sovity/edc-ui:2.2.0` +- Sovity EDC CE: [`7.0.0`](https://github.com/sovity/edc-extensions/releases/tag/v7.0.0) + ## [v2.0.2] - 2023-11-23 ### Overview @@ -75,7 +101,6 @@ _No special migration steps required._ - Broker UI Docker Image: `ghcr.io/sovity/edc-ui:2.1.0` - Sovity EDC CE: [`6.0.0`](https://github.com/sovity/edc-extensions/releases/tag/v6.0.0) - ## [v2.0.0] - 2023-11-17 ### Overview @@ -104,9 +129,12 @@ EDC 0 Release, some bugfixes. 1. Connectors and Data Offers require an initial crawl before their metadata is filled again. 2. UI Migration Notes since the last Broker Release: https://github.com/sovity/edc-ui/releases/tag/v2.0.0 -3. The Protocol Endpoint changed to `https://[MY_EDC_FQDN]/backend/api/dsp`, ~~used to be `https://[MY_EDC_FQDN]/backend/api/v1/ids`~~. -4. The Management Endpoint changed to `https://[MY_EDC_FQDN]/backend/api/management`, ~~used to be `https://[MY_EDC_FQDN]/backend/api/v1/management`~~. -5. The Connector Endpoint changed to `https://[MY_EDC_FQDN]/backend/api/dsp`, ~~used to be `https://[MY_EDC_FQDN]/backend/api/v1/ids/data`~~. +3. The Protocol Endpoint changed to `https://[MY_EDC_FQDN]/backend/api/dsp`, ~~used to + be `https://[MY_EDC_FQDN]/backend/api/v1/ids`~~. +4. The Management Endpoint changed to `https://[MY_EDC_FQDN]/backend/api/management`, ~~used to + be `https://[MY_EDC_FQDN]/backend/api/v1/management`~~. +5. The Connector Endpoint changed to `https://[MY_EDC_FQDN]/backend/api/dsp`, ~~used to + be `https://[MY_EDC_FQDN]/backend/api/v1/ids/data`~~. #### Compatible Versions @@ -258,6 +286,7 @@ Bugfix / Feature Release for the Broker MvP with MS8: Connectors can now be adde - Fixed Backend Docker Healthcheck ### Deployment Migration Notes + 1. Added new **required** configuration properties: ```yaml # Broker Server Admin Api Key (required) @@ -298,14 +327,14 @@ Bugfix / Feature Release for the Broker MvP with MS8: Connectors can now be adde --header 'x-api-key: ApiKeyDefaultValue' \ --data '["https://some-new-connector/api/dsp", "https://some-other-new-connector/api/dsp"]' ``` - + #### Compatible Versions - Broker Backend Docker Image: `ghcr.io/sovity/broker-server-ce:1.0.1` - Broker UI Docker Image: `ghcr.io/sovity/edc-ui:0.0.1-milestone-8-sovity12` - Sovity EDC CE: [`4.0.1`](https://github.com/sovity/edc-extensions/tree/v4.0.1/connector) -## [v1.0.0] +## [v1.0.0] Release was deleted in favor of above release. There was a bug, and we just decided to re-do the release. diff --git a/connector/.env b/connector/.env index f47574cf..ca37ee84 100644 --- a/connector/.env +++ b/connector/.env @@ -71,7 +71,9 @@ EDC_BROKER_SERVER_CATALOG_PAGE_PAGE_SIZE=20 # =========================================================== # Ports and Paths -MY_EDC_NAME_KEBAB_CASE=broker +MY_EDC_PARTICIPANT_ID=broker +EDC_CONNECTOR_NAME=${MY_EDC_PARTICIPANT_ID:-MY_EDC_NAME_KEBAB_CASE} +EDC_PARTICIPANT_ID=${MY_EDC_PARTICIPANT_ID:-MY_EDC_NAME_KEBAB_CASE} MY_EDC_BASE_PATH=/backend MY_EDC_PROTOCOL=https:// WEB_HTTP_PORT=11001 @@ -96,7 +98,7 @@ EDC_DATASOURCE_DEFAULT_PASSWORD=$MY_EDC_JDBC_PASSWORD # Oauth default configurations for compatibility with sovity DAPS EDC_OAUTH_PROVIDER_AUDIENCE=${EDC_OAUTH_TOKEN_URL} EDC_OAUTH_ENDPOINT_AUDIENCE=idsc:IDS_CONNECTORS_ALL -EDC_AGENT_IDENTITY_KEY=sub +EDC_AGENT_IDENTITY_KEY=referringConnector # This file could contain an entry replacing the EDC_KEYSTORE ENV var, # but for some reason it is required, and EDC won't start up if it isn't configured. diff --git a/gradle.properties b/gradle.properties index 2262570d..54c469ed 100644 --- a/gradle.properties +++ b/gradle.properties @@ -3,7 +3,7 @@ sovityBrokerServerGroup=de.sovity.broker sovityBrokerServerVersion=0.0.1-SNAPSHOT # Sovity EDC Extensions (for common api model) -sovityEdcExtensionsVersion=6.0.0 +sovityEdcExtensionsVersion=7.0.0 sovityEdcExtensionGroup=de.sovity.edc.ext sovityEdcGroup=de.sovity.edc