Skip to content

Enforce minor version changes and eLab 5.5 support #176

Merged
mhxion merged 15 commits intodevfrom
elabftw-5.5-ready
Apr 2, 2026
Merged

Enforce minor version changes and eLab 5.5 support #176
mhxion merged 15 commits intodevfrom
elabftw-5.5-ready

Conversation

@mhxion
Copy link
Copy Markdown
Member

@mhxion mhxion commented Mar 31, 2026

Better Version Enforcing

Given @NicolasCARPi's word elabftw/elabftw#6581 (comment) that minor version updates wouldn't break APIs ;) we can now confidently enforce the minor versions. This PR adds support for abort_minor_only and warn_minor_only for the elab_strict_version_match configuration field.

# elapi.yml
elab_strict_version_match: warn_minor_only

warn_minor_only is also now the default value for when elab_strict_version_match doesn't exist. The *_minor_only value is triggered when the installed minor version X.Y.Z -> X.Y doesn't match elAPI's most supported version A.B. With abort_minor_only elAPI will show an error and quit, with warn_minor_only elAPI will show a warning and let the API request go through anyway. elab_strict_version_match: abort now can be seen as the more aggressive counterpart where the whole version string X.Y.Z must match.

This also means we need not to worry about falling behind adding version strings to elAPI as soon as eLabFTW updates.

Recent Versions Support

This PR adds support for eLabFTW 5.4 - 5.5.5. So far no breaking changes. All plugins and examples are working without changes.

@mhxion mhxion changed the title Guardrail for minor version changes and eLab 5.5 support Enforce minor version changes and eLab 5.5 support Mar 31, 2026
@mhxion mhxion mentioned this pull request Mar 31, 2026
@mhxion mhxion requested a review from alexander-haller March 31, 2026 18:18
@mhxion mhxion self-assigned this Mar 31, 2026
@mhxion mhxion linked an issue Mar 31, 2026 that may be closed by this pull request
Copy link
Copy Markdown
Contributor

@alexander-haller alexander-haller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

warn_minor_only as the new default 👍
TY!

@mhxion
Copy link
Copy Markdown
Member Author

mhxion commented Apr 2, 2026

I updated the description to add elab_strict_version_match: warn_minor_only.

@mhxion mhxion merged commit 4af9aa4 into dev Apr 2, 2026
@mhxion mhxion deleted the elabftw-5.5-ready branch April 2, 2026 12:35
@mhxion mhxion mentioned this pull request Apr 2, 2026
mhxion added a commit that referenced this pull request Apr 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

elapi whomai command does not work with API token without the ID prefix

2 participants