Steps for an official release

From OpenEMR Project Wiki


Steps detailing a release (7.0.2 is given as an example).

1. Create a rel-702 branch from master in the git repo.

  • Create this in github (very straightforward) and protect the branch to not allow force pushing and also only allow integrator group to write to it.
  • Also need to update Github Actions related stuff in .github/workflows/ and at top of main

2. Release an online development demo that uses the rel-702 branch and updates daily.

  • Also provide links for downloading rel-702 daily builds/packages(zip and tarball) to allow testing of installation and upgrading by testers

3. Publish installation, upgrade, and downloading instructions. Also set minimum php version.

  • Ensure have the ONC requirements page created and linked in instruction sets (install set, upgrade set, download webpage).
  • The is published as the link for API documentation and as the link for posting Service Base URLs. Thus that link will always need to be redirected to the most current OpenEMR_7.0.x_API version API page. It will be easy for 7.0.0 since will just keep what have (note do need to adjust the links in the page to go to correct branch and not master and also need to adjust the fhir demo links). When got to 7.0.1 will need to redirect OpenEMR_7.0.0_API to OpenEMR_7.0.1_API and move OpenEMR_7.0.0_API original material to another page (maybe OpenEMR_7.0.0_API-prior) again updating links and fhir demo links. When go to 7.0.2 just simply need to redirect OpenEMR_7.0.0_API to OpenEMR_7.0.2_API (which is copy of OpenEMR_7.0.1_API with updated links) and keep OpenEMR_7.0.1_API same name. Note that Service Based URLs is a template (at template:ServiceBaseURLs) so will show in every API page (which is what we want).
  • Also need to manage the which is akin to how do the API pages above.

4. Finalize the translations in the rel-702 branch.

5. Bug fix and finalize the rel-702 branch.

  • Update the copyright/acknowledgements page by copying the copyright page from HERE to acknowledge_license_cert.html in openemr codebase

6. Create a list of new features in the rel-702 branch (since the last official release)

7. Prepare for docker upgrade

  1. Increment docker-version file (increment number by 1) in openemr base directory (in both master and rel-702 branch)
  2. Increment docker-version file (increment number by 1) in openemr sites/default directory (in both master and rel-702 branch)
  3. Increment docker-version file (increment number by 1) in docker /root/ (this is in the upgrade directory in the repo) (do this for both 7.0.2 and future 7.0.3 dockers)
  4. Create fsupgrade-<number-incremented-to-above>.sh in docker /root/ and at least set priorOpenemrVersion and do the database upgrade (this is in the upgrade directory in the repo) (do this for both 7.0.2 and future 7.0.3 dockers)
  5. Edit Dockerfile to bring in the fsupgrade-<number-incremented-to-above>.sh and docker-version file into the docker (these are in the upgrade directory in the repo) (do this for both 7.0.2 and future 7.0.3 dockers)

8. Release rel-702 branch by tagging in git repo with v7_0_2.

  • Things to remember before tagging the release.
  • Remove -dev from $v_tag (make it blank) in the version.php file
  • Ensure the 'allow_debug_language' global in locale section in library/ is defaulted to 0
  • Set version in images in the following docker-compose.yml scripts: docker/production/docker-compose.yml, docker/production-arm/docker-compose.yml
  • In, set openemr version and do a api docs build
  • Set version in composer.json
  • In git repo:
git tag v7_0_2 rel-702

9. Build the docker, tar.gz and zip packages from v7_0_2.

Use following script for the tar.gz and zip packages:
Build the docker via the github action for the docker (and ensure it gets the `latest` tag)

10. Release packages on sourceforge

  • Upload via Project Admin
  • Upload release and a release notes file
  • Set file properties appropriately

11. Announce Release

Use the follow social channels to announce the release in ~140 characters or less with a link to the formal release marketing piece or, if the release is a minor or patch release, a link to the wiki release changelog.

Update the OpenEMR Wikipedia entry:

  • Wikipedia

If the release is a major release (as opposed to minor or patch releases), it is best to put together a nice marketing piece describing the release changes (screenshots are encouraged with new features!). Use as inspiration. This release announcement should be posted on the following sites:

  • OpenHealthNews
  • HackerNews

TODO: are there any other OSS sites that would be interested in having OpenEMR releases pop up in their feeds?

12. Build and release the Cloud packages.

  1. AWS