Merge pull request #24 from medizininformatik-initiative/add-release-…

…documents Add Release Documents
medizininformatik-initiative · Aug 8, 2024 · a758350 · a758350
2 parents d207959 + b667b1e
commit a758350
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -0,0 +1,17 @@
+# Development
+
+## Release Checklist
+
+* create a release branch called `release-v<version>` like `release-v0.1.1`
+* rename every occurrence of the old version, say `2.2.0-SNAPSHOT` into the new version, say `2.2.0`
+* rename every occurrence of old Docker images like `ghcr.io/medizininformatik-initiative/fhir-data-evaluator:0.1.0` 
+into the new image, say `ghcr.io/medizininformatik-initiative/fhir-data-evaluator:0.1.1`
+* update the CHANGELOG based on the milestone
+* create a commit with the title `Release v<version>`
+* create a PR from the release branch into main
+* merge that PR
+* create and push a tag called `v<version>` like `v0.1.1` on main at the merge commit
+* create a new branch called `next-dev` on top of the release branch
+* change the version in the POM to the next SNAPSHOT version which usually increments the minor version
+* merge the `next-dev` branch back into develop
+* create release notes on GitHub