From 15d6cb114fe2fb08fad574e43fa06e43c8f9b8b9 Mon Sep 17 00:00:00 2001 From: Kamil Czaja <46053356+kamilczaja@users.noreply.github.com> Date: Tue, 20 Aug 2024 18:16:44 +0200 Subject: [PATCH] chore: release prep (#282) --- .github/ISSUE_TEMPLATE/release.md | 8 +-- CHANGELOG.md | 70 +++++++++++++------ .../DeploymentEnvironmentService.kt | 5 +- .../gradle/libs.versions.toml | 2 +- .../goals/production/README.md | 6 +- 5 files changed, 60 insertions(+), 31 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md index 8890629b0..a6063d146 100644 --- a/.github/ISSUE_TEMPLATE/release.md +++ b/.github/ISSUE_TEMPLATE/release.md @@ -12,6 +12,7 @@ assignees: "" Feel free to edit this release checklist in-progress depending on what tasks need to be done: +- [ ] Check whether the flyway migrations in Authority Portal and sovity EDC-CE Catalog Crawler are identical. If not, you cannot proceed with the release or you need to make clear which EDC CE version is compatible and vice versa - [ ] Release [sovity EDC CE](https://github.com/sovity/edc-ce), this might require several steps, first of which is to [create a new `Release` issue](https://github.com/sovity/edc-ce/issues/new/choose) - [ ] Decide a release version depending on major/minor/patch changes in the CHANGELOG.md. @@ -21,7 +22,7 @@ Feel free to edit this release checklist in-progress depending on what tasks nee - [ ] Add a clean `Unreleased` version. - [ ] Add the version to the old section. - [ ] Add the current date to the old version. - - [ ] Bump the EDC CE Version to a released version in the `gradle.libs.toml`. + - [ ] Bump the EDC CE Version to a release version in the `libs.versions.toml`. - [ ] Bump the links to the Catalog Crawler initial deployment guide to the fixed EDC CE Version - [ ] Add all Catalog Crawler or Catalog relevant changelog entries from the newer EDC CE release(s), merge and reword them. @@ -37,14 +38,13 @@ 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. - [ ] Create a release in the [Authority Portal EE](https://github.com/sovity/authority-portal-ee) repository. - [ ] `release-prep` PR: - - [ ] Ensure that the correct Catalog Crawler image is set in EE's `.env`. - - [ ] Copy the [Keycloak theme](https://github.com/sovity/authority-portal/tree/main/authority-portal-keycloak) + - [ ] Copy the [Keycloak themes](https://github.com/sovity/authority-portal/tree/main/authority-portal-keycloak) for all flavors from here to the EE repository. - [ ] Copy the [OAuth2 proxy templates](https://github.com/sovity/authority-portal/tree/main/authority-portal-oauth2-proxy) from here to the EE repository. - [ ] Copy - the [realm.json](https://github.com/sovity/authority-portal/blob/main/authority-portal-backend/authority-portal-quarkus/src/main/resources/realm.json) + the [realm.json](https://github.com/sovity/authority-portal/blob/main/authority-portal-backend/authority-portal-quarkus/src/main/resources/realm.json) files for all flavors from here to the EE repository. - [ ] Update the Catalog Crawler image in EE's `.env`. - [ ] Link this release in the EE changelog. diff --git a/CHANGELOG.md b/CHANGELOG.md index feec2d78a..fd35371f9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,32 +13,60 @@ please see [changelog_updates.md](docs/dev/changelog_updates.md). #### Minor -- Copyable contact email and subject fields on data offer detail dialogs -- Catalog: Organization filter is no longer split into ID and name -- Catalog: Connector filter is no longer split into ID and endpoint -- Catalog: Removed dataspace filter when only one dataspace is known -- Added a message when the CaaS request feature is not available -- Service providers can now provide connectors using a Connector JWKS URL instead of a certificate [#272](https://github.com/sovity/authority-portal/pull/272) -- The configuration summary after registering a connector now shows the value for `EDC_OAUTH_CLIENT_ID` +#### Patch + +### Known issues + +### Deployment Migration Notes + +#### Compatible Versions + +- Authority Portal Backend Docker Image: `ghcr.io/sovity/authority-portal-backend:{{ version }}` +- Authority Portal Frontend Docker Image: `ghcr.io/sovity/authority-portal-frontend:{{ version }}` +- Catalog Crawler CE: `ghcr.io/sovity/catalog-crawler-ce:{{ CE VERSION }}` +- Sovity EDC CE: {{ CE Release Link }} + +## [v4.0.0] - 2024-08-20 + +### Overview + +This release introduces support for UI branding configuration, adds improvements to the process of registering connectors for service providers and fixes several minor issues. +Check the deployment migration notes to ensure that you configured everything correctly. + +### Detailed Changes + +#### Major + +- The portal now supports multiple theme configurations + +#### Minor + +- Catalog + - Added copyable contact email and subject fields in the data offer detail dialog + - Organization filter is no longer split into ID and name + - Connector filter is no longer split into ID and endpoint + - Removed dataspace filter when only one dataspace is configured +- Service provider + - Service providers can now provide connectors using a Connector JWKS URL instead of a certificate ([#272](https://github.com/sovity/authority-portal/pull/272)) + - The configuration summary after registering a connector now shows the value for `EDC_OAUTH_CLIENT_ID` +- Added a message on the CaaS request page to inform the user in case the feature is not configured #### Patch -- Fixed user not being redirected to the correct URL after login -- Copyable contact email and subject fields on data offer detail dialogs -- Fixed the close button on the self-hosted/CaaS connector choice page [#258](https://github.com/sovity/authority-portal/issues/258) -- Fixed Dashboard showing uptimes of over 100% -- Organization list: Data offer and connector counts now show the correct numbers according to the active environment -- Fixed provider organization ID not showing up on CaaS connectors [#206](https://github.com/sovity/authority-portal/issues/206) +- Fixed user not being redirected to the correct URL after login ([#280](https://github.com/sovity/authority-portal/issues/280)) +- Fixed the close button on the self-hosted/CaaS connector choice page ([#258](https://github.com/sovity/authority-portal/issues/258)) +- Fixed Dashboard showing uptimes of over 100% ([#262](https://github.com/sovity/authority-portal/issues/262)) +- Organization list: Data offer and connector counts now show the correct numbers according to the active environment ([#255](https://github.com/sovity/authority-portal/issues/255)) +- Fixed provider organization ID not showing up on CaaS connectors ([#206](https://github.com/sovity/authority-portal/issues/206)) - Keep in mind that sovity needs to be registered in the portal for the ID to show up. - Already registered connectors will be updated automatically, this process can take up to 24 hours -- Fixed the close button on the self-hosted/CaaS connector choice page [#258](https://github.com/sovity/authority-portal/issues/258) -- Adjusted connector status naming for more consistency [#270](https://github.com/sovity/authority-portal/issues/270) +- Fixed the close button on the self-hosted/CaaS connector choice page ([#258](https://github.com/sovity/authority-portal/issues/258)) +- Adjusted connector status naming for more consistency ([#270](https://github.com/sovity/authority-portal/issues/270)) - `RUNNING (CaaS) -> ONLINE` - `STOPPED (CaaS) -> OFFLINE` - `DEAD -> OFFLINE` - Breadcrumbs now show "Catalogue" properly when using the MDS theme - -### Known issues +- Removed requirement for an environment with ID `test` ### Deployment Migration Notes @@ -80,10 +108,10 @@ Environment variable changes: #### Compatible Versions -- Authority Portal Backend Docker Image: `ghcr.io/sovity/authority-portal-backend:{{ version }}` -- Authority Portal Frontend Docker Image: `ghcr.io/sovity/authority-portal-frontend:{{ version }}` -- Catalog Crawler CE: `ghcr.io/sovity/catalog-crawler-ce:{{ CE VERSION }}` -- Sovity EDC CE: {{ CE Release Link }} +- Authority Portal Backend Docker Image: `ghcr.io/sovity/authority-portal-backend:4.0.0` +- Authority Portal Frontend Docker Image: `ghcr.io/sovity/authority-portal-frontend:4.0.0` +- Catalog Crawler CE: `ghcr.io/sovity/catalog-crawler-ce:10.2.0` +- Sovity EDC CE: [`10.2.0`](https://github.com/sovity/edc-ce/releases/tag/v10.2.0) ## [v3.1.0] - 2024-07-24 diff --git a/authority-portal-backend/authority-portal-quarkus/src/main/kotlin/de/sovity/authorityportal/web/environment/DeploymentEnvironmentService.kt b/authority-portal-backend/authority-portal-quarkus/src/main/kotlin/de/sovity/authorityportal/web/environment/DeploymentEnvironmentService.kt index 0502f7ff1..0fddc833b 100644 --- a/authority-portal-backend/authority-portal-quarkus/src/main/kotlin/de/sovity/authorityportal/web/environment/DeploymentEnvironmentService.kt +++ b/authority-portal-backend/authority-portal-quarkus/src/main/kotlin/de/sovity/authorityportal/web/environment/DeploymentEnvironmentService.kt @@ -26,8 +26,9 @@ class DeploymentEnvironmentService { lateinit var deploymentEnvironmentConfiguration: DeploymentEnvironmentConfiguration fun onStartUp(@Observes event: StartupEvent) { - // TODO: validate all found deployment environments - assertValidEnvId("test") + findAll().ifEmpty { + error("No deployment environments were configured. Please configure at least one environment.") + } } fun findAll(): Map = deploymentEnvironmentConfiguration.environments() diff --git a/authority-portal-backend/gradle/libs.versions.toml b/authority-portal-backend/gradle/libs.versions.toml index a9f3c602e..f6f3ea231 100644 --- a/authority-portal-backend/gradle/libs.versions.toml +++ b/authority-portal-backend/gradle/libs.versions.toml @@ -3,7 +3,7 @@ java = "17" kotlin = "1.9.22" npmVersion = "8.15.0" -sovity-edcCe = "10.1.0" +sovity-edcCe = "10.2.0" quarkus = "3.9.2" quarkus-keycloakAdminClientReactive = "3.6.6" diff --git a/docs/deployment-guide/goals/production/README.md b/docs/deployment-guide/goals/production/README.md index f400fea08..d8eb03c8a 100644 --- a/docs/deployment-guide/goals/production/README.md +++ b/docs/deployment-guide/goals/production/README.md @@ -314,8 +314,8 @@ AUTHORITY_PORTAL_FRONTEND_LEGAL_NOTICE_URL: https://yourdataspace.com/legal-noti AUTHORITY_PORTAL_FRONTEND_PRIVACY_POLICY_URL: https://yourdataspace.com/privacy-policy # Privacy policy URL AUTHORITY_PORTAL_FRONTEND_SUPPORT_URL: https://support.yourdataspace.com # Support page URL AUTHORITY_PORTAL_FRONTEND_ACTIVE_PROFILE: sovity-open-source # UI Branding profile (sovity-open-source or mds-open-source) -AUTHORITY_PORTAL_FRONTEND_DATASPACE_SHORT_NAME: MDS # Short Dataspace name, used in some explanatory texts -AUTHORITY_PORTAL_FRONTEND_PORTAL_DISPLAY_NAME: "MDS Portal" # Portal name displayed in various texts +AUTHORITY_PORTAL_FRONTEND_DATASPACE_SHORT_NAME: ExDS # Short Dataspace name, used in some explanatory texts +AUTHORITY_PORTAL_FRONTEND_PORTAL_DISPLAY_NAME: "Authority Portal" # Portal name displayed in various texts ``` ### Data Catalog Crawlers @@ -324,7 +324,7 @@ AUTHORITY_PORTAL_FRONTEND_PORTAL_DISPLAY_NAME: "MDS Portal" # Portal name displa - Each deployment environment requires a Data Catalog Crawler. - A Data Catalog Crawler is based on the EDC Connector and crawls the catalogs of all connectors in the dataspace. - You will need an SKI/AKI client ID to register the crawler. Please refer to the [EDC documentation](https://github.com/sovity/edc-ce/tree/main/docs/getting-started#faq) on how to generate one. -- See the [Catalog Crawler Productive Deployment Guide](https://github.com/sovity/edc-ce/blob/v10.0.0/docs/deployment-guide/goals/catalog-crawler-production/README.md) +- See the [Catalog Crawler Productive Deployment Guide](https://github.com/sovity/edc-ce/blob/v10.2.0/docs/deployment-guide/goals/catalog-crawler-production/README.md) ## Initial Setup