Release 8.1.0

[efiege]

Release

Work Breakdown

Feel free to edit this release checklist in-progress depending on what tasks need to be done:

• Release edc-ui, this might require several steps, first of which is to create a new Release issue
• Decide a release version depending on major/minor/patch changes in the CHANGELOG.md.
• Update this issue's title to the new version
• release-prep PR:
  • Write or review the current Productive Deployment Guide
  • Write or review the current Development Deployment Guide
  • Write or review the current Local Demo Deployment Guide
  • For Major version updates: If we want to continue supporting the old major version:
    • Keep the old Productive Development Guide in a separate location.
      • Add a note to the old version about its deprecation status.
      • Add a Link the old version in the new version for discoverability.
      • Check all links in the old version.
    • Keep the old Productive Development Guide in a separate location.
      • Add a note to the old version about its deprecation status.
      • Add a Link the old version in the new version for discoverability.
      • Check all links in the old version.
  • Update the CHANGELOG.md.
    • Add a clean Unreleased version.
    • Add the version to the old section.
    • Add the current date to the old version.
    • Check the commit history for commits that might be product-relevant and thus should be added to the
      changelog. Maybe they were forgotten.
    • Write or review the Deployment Migration Notes section, check the commit history for changed / added
      configuration properties.
    • Write or review a release summary.
    • Write or review the compatible versions section.
    • Add a link to the EDC UI Release to the "EDC UI" section.
    • Add a link to the EDC UI Release Deployment Migration Notes from the Deployment Migration section if the EDC UI has Deployment Migration Notes.
    • Remove empty sections from the patch notes.
  • Replace the existing docker-compose.yaml with docker-compose-dev.yaml.
  • Set the version for EDC_IMAGE of
    the docker-compose's .env file.
  • Set the version for TEST_BACKEND_IMAGE of
    the docker-compose's .env file.
  • Set the version for BROKER_IMAGE of
    the docker-compose's .env file.
  • Set the UI release version for EDC_UI_IMAGE of
    the docker-compose's .env file.
  • If the Eclipse EDC version changed, update
    the eclipse-edc-management-api.yaml file.
  • Run all tests locally as long as the GH flaky tests are a problem.
  • Merge the release-prep PR.
• Wait for the main branch to be green. You can check the status in GH actions.
• Validate the image
  • Pull the latest edc-dev image: docker image pull ghcr.io/sovity/edc-dev:latest.
  • Check that your image was built recently docker image ls | grep ghcr.io/sovity/edc-dev.
  • Test the release docker-compose.yaml with EDC_IMAGE=ghcr.io/sovity/edc-dev:latest and BROKER_IMAGE=ghcr.io/sovity/broker-server-dev:latest (at minimum execute a transfer between the two connectors).
    • EDC
      • Test with EDC_UI_ACTIVE_PROFILE=sovity-open-source
      • Test with EDC_UI_ACTIVE_PROFILE=mds-open-source
    • Broker
      • Validate that the EDC is scanned.
      • Validate that the index is searchable.
  • Ensure with a docker ps -a that all containers are healthy, and not healthy: starting or healthy: unhealthy.
• Create a release
  • In Choose the tag, type your new release version in the format vx.y.z (for instance v1.2.3) then click +Create new tag vx.y.z on release.
  • 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).
• Revisit the changed list of tasks and compare it
  with .github/ISSUE_TEMPLATE/release.md.
  Propose changes where it makes sense.
• Close this issue.
• Inform the Product Manager of this new release