From 017c6e3532f8b2462560ccc013a0fff244eec965 Mon Sep 17 00:00:00 2001 From: Jon Bartels Date: Tue, 7 Apr 2026 19:41:28 -0400 Subject: [PATCH 1/5] Release HOWTO Signed-off-by: Jon Bartels Signed-off-by: Jon Bartels <--global> --- RELEASE-HOWTO.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 RELEASE-HOWTO.md diff --git a/RELEASE-HOWTO.md b/RELEASE-HOWTO.md new file mode 100644 index 0000000000..77d12a8650 --- /dev/null +++ b/RELEASE-HOWTO.md @@ -0,0 +1,63 @@ +# HOWTO Release Open Integration Engine + +## Audience + +This document is primarily meant to be referenced by OIE maintainers. This document is meant to help maintainers perform releases with a consistent process. This document may be useful to forks who want to release in a similar way. This document should also be updated with PRs that improve or change the release process. + +## Task Overview + +These are the tasks to perform a release: +1. Update version numbers +2. Build the installer +3. Sign the installer +4. Release the installer and artifacts as RC +5. Fix showstopping bugs. Log all others. +5. Release the installer and artifacts as a final release + +These tasks are ordered. They support the direction of the maintainers and steering committee to release regularly. + +## Task Details + +### Update Version Numbers + +Edit the version number in [mirth-build.properties](server/mirth-build.properties) to indicate the release version. + +Execute an automated build and verify that the version is correctly populated. It will appear in various properties and XML files for the application. The old version should be replaced. + +### Build The Installer + +You will need Install4J installed. OIE has an Install4J license available for maintainers. Forks or independent builds will need to acquire their own license. + +Review the [Install4J specific readme.](tools/install4j/readme.html) + +Run Install4J and load the [Install4J configuration for OIE](tools/install4j/oie-installer-config.install4j) + +### Sign The Installer + +You will need a code-signing certificate. OIE has sponsors with these certificates who sign our builds. + +After signing the installer and artifacts ensure that OIE executables, services, and JARs have the expected signature and that it is valid. + +### Publish Installer and Artifacts for Release Candidate + +The installer and artifacts should be published to the [OIE Engine github Releases Section](https://github.com/OpenIntegrationEngine/engine/releases). + +### Bug Report Period + +Elicit feedback from the maintainers and the greater OIE community. Listen to feedback and document it. + +Showstopping bugs should be recorded as issues in the current release milestone and worked on promptly. + +Bug reports that are not showstoppers should be recorded and planned following our typical processes. + +### Publish Installer and Artifacts for Final Release + +Generate the installer and build artifacts for the final release following the same version update, build, and signing process. + +Review the artifacts with the maintainers. + +Collaborate with the OIE steering committee for social media announcements, website updates, etc. + +Publish the releases to the [OIE Engine github Releases Section](https://github.com/OpenIntegrationEngine/engine/releases). + + From 121064b464750ba3473b9cb3f798a3e78b0b0452 Mon Sep 17 00:00:00 2001 From: Jon Bartels Date: Thu, 23 Apr 2026 10:26:10 -0400 Subject: [PATCH 2/5] Update RELEASE-HOWTO.md Improve version number cange with a link to a reference PR Signed-off-by: Jon Bartels --- RELEASE-HOWTO.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/RELEASE-HOWTO.md b/RELEASE-HOWTO.md index 77d12a8650..7eaa42fb2d 100644 --- a/RELEASE-HOWTO.md +++ b/RELEASE-HOWTO.md @@ -20,7 +20,7 @@ These tasks are ordered. They support the direction of the maintainers and steer ### Update Version Numbers -Edit the version number in [mirth-build.properties](server/mirth-build.properties) to indicate the release version. +Edit the version number in several files to indicate the release version. Follow (this PR)[https://github.com/OpenIntegrationEngine/engine/pull/301] as a guide. Execute an automated build and verify that the version is correctly populated. It will appear in various properties and XML files for the application. The old version should be replaced. From 9cafd4fcabc9cad91984c415cdf7abd31d60d606 Mon Sep 17 00:00:00 2001 From: Jon Bartels Date: Fri, 1 May 2026 13:52:51 -0400 Subject: [PATCH 3/5] Update RELEASE-HOWTO.md Add tables showing release testing matricies Signed-off-by: Jon Bartels --- RELEASE-HOWTO.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/RELEASE-HOWTO.md b/RELEASE-HOWTO.md index 7eaa42fb2d..0a11729719 100644 --- a/RELEASE-HOWTO.md +++ b/RELEASE-HOWTO.md @@ -50,6 +50,45 @@ Showstopping bugs should be recorded as issues in the current release milestone Bug reports that are not showstoppers should be recorded and planned following our typical processes. +Ask for volunteers to test some common paths and combinations for OIE. + +OS and DB combinations: + +|OS|DB| +|---|---| +|Windows|Postgres| +|Windows|MS SQL| +|Windows|Oracle| +|Windows|MySQL/Maria| +|Windows|Derby| +|Mac|Postgres| +|Mac|MS SQL| +|Mac|Oracle| +|Mac|MySQL/Maria| +|Mac|Derby| +|Linux|Postgres| +|Linux|MS SQL| +|Linux|Oracle| +|Linux|MySQL/Maria| +|Linux|Derby| + +Install and Upgrade paths: + +|OS|Installer|New Install or Upgrade| +|---|---|---| +|Windows|EXE|New| +|Windows|EXE|Upgrade| +|Windows|TAR|New| +|Windows|TAR|Upgrade| +|Mac|EXE|New| +|Mac|EXE|Upgrade| +|Mac|TAR|New| +|Mac|TAR|Upgrade| +|Linux|EXE|New| +|Linux|EXE|Upgrade| +|Linux|TAR|New| +|Linux|TAR|Upgrade| + ### Publish Installer and Artifacts for Final Release Generate the installer and build artifacts for the final release following the same version update, build, and signing process. From 94e7769f041078d20daa25cbce821e253237a6ba Mon Sep 17 00:00:00 2001 From: Jon Bartels Date: Wed, 30 Sep 2026 17:11:31 -0400 Subject: [PATCH 4/5] Add task to generate release notes for releases Added a new task to generate release notes before updating version numbers. Signed-off-by: Jon Bartels --- RELEASE-HOWTO.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/RELEASE-HOWTO.md b/RELEASE-HOWTO.md index 0a11729719..e122adeabe 100644 --- a/RELEASE-HOWTO.md +++ b/RELEASE-HOWTO.md @@ -7,17 +7,24 @@ This document is primarily meant to be referenced by OIE maintainers. This docum ## Task Overview These are the tasks to perform a release: -1. Update version numbers -2. Build the installer -3. Sign the installer -4. Release the installer and artifacts as RC -5. Fix showstopping bugs. Log all others. +1. Generate Release Notes +2. Update version numbers +3. Build the installer +4. Sign the installer +5. Release the installer and artifacts as RC +6. Fix showstopping bugs. Log all others. 5. Release the installer and artifacts as a final release These tasks are ordered. They support the direction of the maintainers and steering committee to release regularly. ## Task Details +## Generate Release Notes + +Release notes can be generated from PRs and commit messages. + +Ensure that Release Notes explicitly list patched CVEs in the typical CVE format, eg CVE-YEAR-NUMBER. + ### Update Version Numbers Edit the version number in several files to indicate the release version. Follow (this PR)[https://github.com/OpenIntegrationEngine/engine/pull/301] as a guide. From 5e272e49e6d7cee1181913062d1b9f694f4e477a Mon Sep 17 00:00:00 2001 From: Jon Bartels Date: Wed, 30 Sep 2026 19:37:04 -0400 Subject: [PATCH 5/5] Update RELEASE-HOWTO.md Signed-off-by: Jon Bartels --- RELEASE-HOWTO.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/RELEASE-HOWTO.md b/RELEASE-HOWTO.md index e122adeabe..094dbf0f63 100644 --- a/RELEASE-HOWTO.md +++ b/RELEASE-HOWTO.md @@ -10,9 +10,10 @@ These are the tasks to perform a release: 1. Generate Release Notes 2. Update version numbers 3. Build the installer -4. Sign the installer -5. Release the installer and artifacts as RC -6. Fix showstopping bugs. Log all others. +4. Submit PR with any install4j changes +5. Sign the installer +6. Release the installer and artifacts as RC +7. Fix showstopping bugs. Log all others. 5. Release the installer and artifacts as a final release These tasks are ordered. They support the direction of the maintainers and steering committee to release regularly. @@ -39,6 +40,10 @@ Review the [Install4J specific readme.](tools/install4j/readme.html) Run Install4J and load the [Install4J configuration for OIE](tools/install4j/oie-installer-config.install4j) +### Submit PR with any install4j changes + +This PR should review the bundled Java version, min/max versions. + ### Sign The Installer You will need a code-signing certificate. OIE has sponsors with these certificates who sign our builds.