Our Community Environments:
| Dev Environment | QA Environment | Production Environment |
|---|---|---|
Most recent committed dev work | Most Recent Release | A specific version of O3 RefApp release |
Sample login for all these is admin/Admin123.
Our Release Process:
| Ongoing: PR Smoke Tests | Step 1: QA Release | Step 2: Manual Checks | Step 3: O3 RefApp Release |
|---|---|---|---|
Automatic tests are set up in the major O3 mono-repos to give devs feedback within minutes after submitting a PR if their work will break a key feature elsewhere within that mono-repo. The latest builds triggered by merged PRs can be reviewed here. | "QA Release": Updating the test3 environment with the latest build and selected work from dev3. "Tags": Moment in time snapshot - what the repo looked like at a particular point in time (points to a particular commit at a particular time where we released something) | Manual last-pass through of O3 using the test3/QA Environment and checking for clinical or other concerns using the O3 Review Checklist | "RefApp Release": https://github.com/openmrs/openmrs-distro-referenceapplication/blob/3.0.0-beta.11/frontend/spa-build-config.json specifies the version of each . |
Each of these steps are explained further below. Full fancy diagram here of the O3 Release Pipeline.
Step 1: QA Release
FIRST, obtain squad permission/buy-in to do a release (e.g. announce on #openmrs3). THEN, in 1 PR, 2 Commits are needed: (Example)
- Step 1.1) Create Release PR:
- TO ADD VERSIONING: Release Commit: (release) Create release commit for beta.9' This fixes the version numbers. Because we don't want the test3 version to be deployed on dev3 because that could undo more recent changes. So, in dev3, we ignore any release with the string '(release'
- Why: Pins a specific version # for all modules that were set as "next" or "SNAPSHOT". This is currently manual because there's still some human judgement and decision making for several specific modules. Example: https://github.com/openmrs/openmrs-distro-referenceapplication/pull/737/commits/f588d806c2511d71f419268d3631b1dfa98781a3
- TO PROTECT DEV3: Release-Revert Commit: (release-revert) Reset to dev versions Second Commit with release revert message that unsets the fixed version numbers.
- Why: Ensures 'main' branch gets back to state where it is still pointing at 'next', to preserve the cutting-edge state of the dev3 environment.
- A GitHub Action is configured to execute comprehensive end-to-end tests on the release commit associated with the Pull Request. It is imperative to verify that all tests are successfully completed before merging the PR (learn more).
- The PR title should start with "(release)" in order to trigger tests.
- TO ADD VERSIONING: Release Commit: (release) Create release commit for beta.9' This fixes the version numbers. Because we don't want the test3 version to be deployed on dev3 because that could undo more recent changes. So, in dev3, we ignore any release with the string '(release'
- Step 1.2) Add Tags
- Tag Release Commit with a tag named after the version number, as shown in the tag list screenshot here:
- Tag Release Commit with a tag named after the version number, as shown in the tag list screenshot here:
- Step 1.3) QA Release then Happens Automatically
- The Tag triggers the QA Release, AND the auto-rebuilding of Test3. In our Bamboo CI, the Deployment project called "Distribution 3.x Releases" is only triggered by tags.
- The Tag triggers the QA Release, AND the auto-rebuilding of Test3. In our Bamboo CI, the Deployment project called "Distribution 3.x Releases" is only triggered by tags.
- Step 1.4) Announce test3 release & version number to community in #openmrs.
Step 2: Manual Checks
- Confirm that tests are passing satisfactorily in Test3. Using the O3 QA Spreadsheet is highly recommended, in addition to checking the automated tests. Go through both the Baseline Checklist and any checks specific to that release - so that new features get some review.
- Remember: Keep an eye out for manual work that could be automated - we want to maximize how we use Automation and reduce manual overhead over time.
Step 3: RefApp Release
Go to the Deployment Project, "Deploy Reference Application 3.x" (under the "Deploy" option in the menu)
Click the cloud icon for the QA build:
- "Create new release" → Use the last successful build, and name the release one version number higher than the last one. When that build finishes, the new O3 RefApp release is automatically pushed to both our "production" environment in o3.openmrs.org and the Docker containers are automatically updated.
- Announce O3 Demo release & version number to community in #openmrs3 and on Talk.
Note: You can see the history of releases here.