OMERO.web release

This document describes the release process for OMERO Web. The release process uses GitHub actions, make sure that the actions are active before pushing any tag.

Register CVE

As soon as a vulnerability is identified, create a security advisory on GitHub. The work to fix the vulnerability will be done using the private copy of ome/omero-web. The release process needs to be adjusted in that case.

Release process

Source code release

See Release process.

Docker container release

Before making a new release of OMERO Web Docker, merge all contributions on the master branch.

A signed tag must be created for the released version using git tag -s:

$ git tag -s -m "Tag version x.y.z" x.y.z

The tag must be pushed upstream:

$ git push origin x.y.z

Website release

When the documentation is deployed, you can make a release of the Open Microscopy Environment website.

To make a release:

  • Update the version in _config.yml

  • Add a new entry under _posts. The name of the post should be YYYY-MM-DD-omero-web-MAJOR.MINOR.PATCH.md e.g. 2024-08-15-omero-web-5.26.0.md

  • Point to the post announcing the release in omero/downloads/index.html.

A signed tag must be created using git tag -s:

$ git tag -s -m "Message" YYYY.MM.DD

Both the master branch as well as the tag must be pushed upstream:

$ git push origin master YYYY.MM.DD

An hourly cron job runs on our virtual machine and deploys the website.

Finally - Announce the release on image.sc using the Announcements category after checking that the website has been deployed.