name | about | title | labels | assignees | ||
---|---|---|---|---|---|---|
Release |
Create an issue to track a release process. |
Release x.x.x |
|
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, 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:- Update the CHANGELOG.md.
- 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 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.
- Add all Catalog Crawler or Catalog deployment migration notes from the newer EDC CE release(s), merge and reword them.
- 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.
- Add a clean
- Wait for the pipeline to be green.
- Merge the
release-prep
PR.
- Update the CHANGELOG.md.
- Wait for the main branch to be green.
- 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 repository.
-
release-prep
PR:- Copy the Keycloak themes for all flavors from here to the EE repository.
- Copy the OAuth2 proxy templates from here to the EE repository.
- Copy the 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.
- Merge the
release-prep
PR. - Deploy a version with the PR-Tag to Sirius and test the deployment.
- Create a release, re-use the changelog section as EE release description.
- Re-use the version of this release as the title for the EE release.
-
- Notify the deployment team, which will send a message to the customer about the new release.
-
release-cleanup
PR:- Revisit the changed list of tasks and compare it with .github/ISSUE_TEMPLATE/release.md. Apply changes where it makes sense.
- Merge the
release-cleanup
PR.