Pro-tip: READ THIS PAGE COMPLETELY before you start. That means, go through each point to make sure you can anticipate any need for clarifications.
OpenMRS Reference Application releases are different than OpenMRS Platform releases. Platform releases usually consist of alpha, beta releases and have Sprints to complete tickets in a short span of time. OpenMRS 2.x is a collection of modules and hence its release consists of releasing all the modules planned to be included in the 2.x release and testing if all of them function collectively.
The release manager needs access to these accounts:
OpenMRS ID: This is the basic account that you create when associating with OpenMRS.
OpenMRS.org account: This is not your OpenMRS ID, it is a WordPress account where you will need to create a blog post once you release the OpenMRS version. Create a new case at OpenMRS helpdesk requesting access for the OpenMRS.org account. Help desk will create the account for you.
CI Bamboo Account: The actual release takes place here. You will need your access to this account to finally release the version. Create a new case at OpenMRS helpdesk requesting access for this account.
Administrator role in JIRA for Reference Application Project: Request for being an administrator of the Reference Application project in JIRA from a current Administrator - Presently Darius Jazayeri is an administrator for the project.
Begin the process of release management:
Analyse the release stage requirements for the particular release by following Technical Roadmap.
This can be done on OpenMRS Talk as done here (using the wiki has advantages, so use it if you are uncertain which to use)
Search for tickets in JIRA that have the release version or having tag as OpenMRS 2.x (the version to be released) and have them fixed before having that module released.
Before people start releasing Reference Application modules, set the bamboo global variable preparing.refapp.distro.release to 'true' (by asking helpdesk if you don't have access)
Make sure that for each module that needs a new version to be released, that the user documentation in the new wiki page has been updated to reflect the UI changes if necessary.
Set an initial deadline to release all the modules scheduled to be included in the release and request each modules owner to release the modules in that time (make this announcement in Talk, mentioning each module owner so they get notified). Excepting the Reference Application, Reference Application distro, Reference Application, reference demo data, reference metadata, all the other module can be released by this time. For the modules already existing in the release bundle check in OpenMRS github account if any new changes have been made after the previous release if don't request the any action just include it in the release management process that it is in a release ready state. If there are changes request the module owners if they would like to release a new version to be included in the new OpenMRS release.
A module should be released and available via Addons to be considered released. Please verify that each module has been released properly.
Releasing the Reference Metadata module:
Each release of Reference Application should be preceded with a release of the Reference Metadata module in a version matching the Reference Application version. The release is typically done by the Reference Metadata module maintainers, but as a release manager you need to make sure it happens.
CIEL dictionary dropbox account: This account is updated with the latest CIEL dictionary and each OpenMRS 2.x release includes the latest released CIEL dictionary. Andrew Kanter manages the account and you would need to mail him requesting the access for the account. CIEL dictionary is an SQL dump file.
mdsbuilder: It is an OpenMRS server and you would need access to the server, an account in the OpenMRS account and also the mysql openmrs_user/root credentials, please create a new case requesting these accounts at OpenMRS helpdesk . For requesting server access you need to have an SSH key pair. (For windows users new to using an SSH key pair for accessing a linux server , this guide might help you create one. You will have to request helpdesk to give access to this SSH key).
Update CIEL on the mdsbuilder to the latest version using the sql dump that you download from the CIEL dictionary dropbox account. Here's the list of commands needed to do the import. Replace "raff" with your username.
scp openmrs_concepts_2.0_20181012.sql.zip email@example.com:/home/raff/openmrs_concepts_2.0_20181012.sql.zip
docker cp /home/raff/openmrs_concepts_2.0_20181012.sql mdsbuilder_db_1:/home/
docker exec -it mdsbuilder_db_1 /bin/bash
mysql -u root -p openmrs < /home/openmrs_concepts_2.0_20181012.sql #use the mysql root password from .env file
Update Metadata Sharing packages to the latest versions of CIEL concepts
Go to Administration -> Metadata Sharing -> Export Metadata and choose a package (repeat b. and c. for the following packages: Reference Application Concepts, Reference Application Diagnoses, Reference Application Order Entry and Allergies Concepts)
Click New Version.
Follow the creating package wizard leaving all defaults.
Click Download Latest to get the zip file for that package.
Export concepts using data exchange to preserve IDs for later updates of CIEL.
Release the Reference Metadata Module with the version matching the release version of OpenMRS 2.x
User Acceptance Testing:
Schedule a time period after the initial release deadline for releasing the modules set under the section Begin the process of release management- 4th point. Even if some modules are not released by this time the testing can begin.
Setup a User Acceptance Testing(UAT) server with the OpenMRS instance having the latest released modules by creating a new case at OpenMRS helpdesk requesting the setup of the server.
Request the Module Owners/Implementers to verify the module's functionality individually.
Organize events to encourage people to participate in testing the new version before it's release.
If the UAT results in discovery of new bugs please file them and after they are fixed , request releasing a new version for the specific module where the issue has been identified.
Final Release Process:
Release all modules to be included in the distribution
Every build stops/pauses at the release stage(you can observe this in the left side column nearing the bottom of the page with section titled Release having a small right-arrow/play symbol beside it).
After verifying the artifacts trigger the release by clicking on the play/right-arrow button next to the Release section located to the left bottom. At this point, you have the opportunity to override the variables on release version (maven.release.version) and the next snapshot on the pom file (maven.development.version); otherwise, maven release plugin will just use its default values. This begins the process of releasing the OpenMRS 2.x version in maven and packaging the released modules and generating the openmrs-standalone.zip.
Make a copy of the current "Reference Application (version)" documentation page (e.g the one for RefApp 2.5 is here), and name it for the next release. Add a note that this version is not yet released.
Remove a note from the current "Reference Application (version)" documentation page that this version is not yet released.
Maintain the list of Contributors for the release.
Create the Release notes:
Create a release notes child page in Release Notes with the release version name.
Update the Release Notes page meta tag with the new page you created.
Announcing the Release
Create a blog post in OpenMRS.org announcing the release, using your WordPress account. If you need an account, create a help desk case at https://help.openmrs.org/customer/portal/emails/new. The announcement can be similar to the ones created before. Please do not forget to include the list of contributors in the announcement.
Announce the release in OpenMRS Talk similar to the blog post.
.Create a new case at OpenMRS helpdesk requesting to update demo.openmrs.org, the OpenMRS.org home page and downloads page to the latest release. Please provide links to the downloads. DO NOTmark the Impact of your case as anything other than Routine.
Release in JIRA
Request for being an administrator of the Reference Application project in JIRA from a current Administrator - Presently Darius Jazayeri is an administrator for the project. Ensure that all tickets are in the ACCEPTED state, before you release in JIRA.
Create a maintenance branch off the latest released tag if it doesn't exist, forintsance if the current release of the reference application is 2.6 or 2.6.0, create a 2.6.x branch, below are the steps;
Change the version in the pom files in all the sub projects to a snapshot version e.g if the latest release is 2.6 or 2.6.0 and the branch name is 2.6.x, then the new version in the pom files would be 2.6.1-SNAPSHOT and commit the changes.
Then push the new branch out to origin and upstream.
At the top of the page in the title section, there is a drop down to switch build branches, you need to set it to the branch you created above.
You need to override the maven variables for the branch build, click the Actions button and select Configure branch from the drop down, at this point you have the opportunity to set the plan variables below otherwise, maven release plugin will just use its default values;
maven.release.version: The maintenance version you intend to release
maven.development.version: The next snapshot version in the pom files
openMRSVersion: The version number of the platform you intend to package
To start the release process, you need to click the Run button from the build plan page, and select Run branch option from the drop down.
Every build stops/pauses at the release stage (you can observe this in the left side column nearing the bottom of the page with section titled Release having a small right-arrow/play symbol beside it).
Trigger the release by clicking on the play/right-arrow button next to the Release section located to the left bottom, this begins the process of releasing the OpenMRS 2.x version in maven and packaging the released modules and generating the openmrs-standalone.zip.