Skip to content

Latest commit

 

History

History
46 lines (42 loc) · 3.15 KB

release.md

File metadata and controls

46 lines (42 loc) · 3.15 KB
name about title labels assignees
Release
Create an issue to track a release process.
Release x.x.x
task/release
scope/mds

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.
  • Release edc-extensions, this might require several steps.
  • 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:
    • Update the CHANGELOG.md.
      • Add a clean Unreleased version.
      • Add the version to the old section.
      • Add the current date to the old version.
      • Write or review the Deployment Migration Notes section.
      • Ensure the Deployment Migration Notes contains the compatible docker images.
      • Write or review a release summary.
      • Remove empty sections from the patch notes.
    • Update the gradle.properties to contain the released edc-extensions version.
    • Set the broker server release version in the docker-compose's .env file.
    • Set the EDC UI release version in the docker-compose's .env file.
    • Set the EDC CE release version in the docker-compose's .env file.
    • Merge the release-prep PR.
  • Wait for the main branch to be green.
  • Test the docker-compose.yaml with BROKER_IMAGE=ghcr.io/sovity/broker-server-dev:main.
  • 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.
  • Check the contents of the Deployment Docs Zip from the GitHub Release.
  • Notify the deployment team with Deployment Docs Zip file attached to the release, which should now contain both product changes and a deployment migration guide.
  • release-cleanup PR: