|
| 1 | +# HOWTO Release Open Integration Engine |
| 2 | + |
| 3 | +## Audience |
| 4 | + |
| 5 | +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. |
| 6 | + |
| 7 | +## Task Overview |
| 8 | + |
| 9 | +These are the tasks to perform a release: |
| 10 | +1. Update version numbers |
| 11 | +2. Build the installer |
| 12 | +3. Sign the installer |
| 13 | +4. Release the installer and artifacts as RC |
| 14 | +5. Fix showstopping bugs. Log all others. |
| 15 | +5. Release the installer and artifacts as a final release |
| 16 | + |
| 17 | +These tasks are ordered. They support the direction of the maintainers and steering committee to release regularly. |
| 18 | + |
| 19 | +## Task Details |
| 20 | + |
| 21 | +### Update Version Numbers |
| 22 | + |
| 23 | +Edit the version number in [mirth-build.properties](server/mirth-build.properties) to indicate the release version. |
| 24 | + |
| 25 | +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. |
| 26 | + |
| 27 | +### Build The Installer |
| 28 | + |
| 29 | +You will need Install4J installed. OIE has an Install4J license available for maintainers. Forks or independent builds will need to acquire their own license. |
| 30 | + |
| 31 | +Review the [Install4J specific readme.](tools/install4j/readme.html) |
| 32 | + |
| 33 | +Run Install4J and load the [Install4J configuration for OIE](tools/install4j/oie-installer-config.install4j) |
| 34 | + |
| 35 | +### Sign The Installer |
| 36 | + |
| 37 | +You will need a code-signing certificate. OIE has sponsors with these certificates who sign our builds. |
| 38 | + |
| 39 | +After signing the installer and artifacts ensure that OIE executables, services, and JARs have the expected signature and that it is valid. |
| 40 | + |
| 41 | +### Publish Installer and Artifacts for Release Candidate |
| 42 | + |
| 43 | +The installer and artifacts should be published to the [OIE Engine github Releases Section](https://github.com/OpenIntegrationEngine/engine/releases). |
| 44 | + |
| 45 | +### Bug Report Period |
| 46 | + |
| 47 | +Elicit feedback from the maintainers and the greater OIE community. Listen to feedback and document it. |
| 48 | + |
| 49 | +Showstopping bugs should be recorded as issues in the current release milestone and worked on promptly. |
| 50 | + |
| 51 | +Bug reports that are not showstoppers should be recorded and planned following our typical processes. |
| 52 | + |
| 53 | +### Publish Installer and Artifacts for Final Release |
| 54 | + |
| 55 | +Generate the installer and build artifacts for the final release following the same version update, build, and signing process. |
| 56 | + |
| 57 | +Review the artifacts with the maintainers. |
| 58 | + |
| 59 | +Collaborate with the OIE steering committee for social media announcements, website updates, etc. |
| 60 | + |
| 61 | +Publish the releases to the [OIE Engine github Releases Section](https://github.com/OpenIntegrationEngine/engine/releases). |
| 62 | + |
| 63 | + |
0 commit comments