Fixes GitHub workflow generating documentation from release artifacts#2506
Merged
Conversation
The current logic builds OMERO.server from source which has several downsides including pulling artifacts from OME artifactory on every build and trying to generate documentation from unreleased content. Using gh release download with the GH token should considerably speed up build times
jburel
reviewed
Dec 4, 2025
| git clone https://github.com/ome/omeroweb-install | ||
| git clone https://github.com/ome/omero-install | ||
| - name: Build OMERO.server | ||
| - name: Download latest release of OMERO.server |
Member
There was a problem hiding this comment.
This means that the configuration changes will only be included in the documentation after a release of the OMERO.server and not when PRs are merged.
This means that as we have seen previously the configuration text might be incorrect or not correctly displayed. We will not be able to catch that. This is probably okay to pay that cost since we are also reducing the build time significantly
Member
Author
There was a problem hiding this comment.
Agreed, for simple changes like typos/descriptions, the generation step creates a bit of unnecessary friction as you might need to wait until the next release.
On the other side:
- the generation of the configuration properties page has been turned off in ba0ee84 for more than a year. So reenabling those is an improvement
- building OMERO.server from source across these repositories is currently not a viable option. We'll need to look into this issue separately as it is currently failing the builds on ome/openmicroscopy and blocking the release workflow of OMERO.server.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This effort was primarily motivated to propagate some of the property changes associated with the OMERO.web 5.30.0 release to the OMERO documentation.
A few issues were found as part of an initial investigation:
omero config parsecommand is skipped inautogen_openmicroscopy.shand several configuration properties are out-of-syncautogen_db_version.pywith an error of typepackaging.version.InvalidVersion: Invalid version: '4.3__0'To address all of the above, the following changes are proposed:
gh release download, similarly to the OMERO.py GitHub workflow. TheSUFFIXandBUILDvariables are removed or disabled.autogen_db_version.pyis updated to only detect SQL files and folders corresponding to release versions of the OMERO database i.e. under the form<MAJOR>.<MINOR>__<PATCH>, excluding historical schema versions as well as all intermediate DEV database versions. The usage ofpackaging.versionis dropped in favour of theget_mmap()peter-evans/create-pull-requestaction is updated tov7and usesGITHUB_TOKENunder the hoodNote this workflow is currently configured to run in a
cronmatter making changes hard to evaluate. As a proof of concept, sbesson#8 was generated by https://github.com/sbesson/omero-documentation/actions/runs/19940358557 which includes an extra commit on top of this branch to force the workflow and a build time <2min