Skip to content

fix: add properties to eln export required to pass ELN Format tests - #467

Merged
omkar-ethz merged 1 commit into
mainfrom
eln-export-fix
Feb 2, 2026
Merged

fix: add properties to eln export required to pass ELN Format tests#467
omkar-ethz merged 1 commit into
mainfrom
eln-export-fix

Conversation

@omkar-ethz

@omkar-ethz omkar-ethz commented Jan 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

This PR fixes some issues with eln export, required to pass tests of TheELNFileFormat:

  1. In the SciLog eln export, some entities were missing as per the ROCrate spec (license, datePublished), and sdPublisher as per ELN spec. This PR adds these entities to the metadata node.
  2. A Comment node is also a dataset. Before, it was only linked to Paragraph via the comment property. But roc-validator run as part of ELNFileFormat's CI complains that it should be child of another dataset node - hence, we also add comments as child datasets of the root dataset, along with paragraphs.

TheELNFormat PR: TheELNConsortium/TheELNFileFormat#141

@omkar-ethz omkar-ethz changed the title fix: add properties to eln export to pass ELN Format CI fix: add properties to eln export required to pass ELN Format tests Jan 30, 2026
@omkar-ethz
omkar-ethz marked this pull request as ready for review January 30, 2026 09:38
@omkar-ethz
omkar-ethz requested a review from a team January 30, 2026 09:39
@omkar-ethz
omkar-ethz merged commit 616385c into main Feb 2, 2026
1 check passed
@omkar-ethz
omkar-ethz deleted the eln-export-fix branch February 2, 2026 12:25
github-actions Bot pushed a commit to HayenNico/scilog that referenced this pull request Mar 12, 2026
@semantic-release-bot
chore(release): 1.0.0 [skip ci]
b755d98 
# 1.0.0 (2026-03-12)

### Bug Fixes

* add createdBy to readACL as well ([paulscherrerinstitute#462](https://github.com/HayenNico/scilog/issues/462)) ([2856059](2856059))
* add properties to eln export to pass ELN Format CI ([paulscherrerinstitute#467](https://github.com/HayenNico/scilog/issues/467)) ([616385c](616385c))
* add token_prefix option to accomodate be_next ([paulscherrerinstitute#442](https://github.com/HayenNico/scilog/issues/442)) ([2ed44ab](2ed44ab))
* added missing logbook_message file ([a624d3f](a624d3f))
* always get the latest version from the editor before submitting; closes [paulscherrerinstitute#206](https://github.com/HayenNico/scilog/issues/206) ([9e82bb3](9e82bb3))
* bind scilog version ([paulscherrerinstitute#476](https://github.com/HayenNico/scilog/issues/476)) ([751614c](751614c))
* **ci:** use conventionalcommits preset for calculating the new semver ([a42261b](a42261b))
* **deps:** add formidable as direct dependency ([e6fbbd2](e6fbbd2))
* **deps:** update dependency formidable to v2.1.3 [security] ([8360fa9](8360fa9))
* **deps:** update dependency multer to v2 [security] ([e27f6c7](e27f6c7))
* fixed editor style for resized images ([fbb9e91](fbb9e91))
* fixed link for files ([34b0a7b](34b0a7b))
* increased idle time for updates from 1s to 5s; closes [paulscherrerinstitute#197](https://github.com/HayenNico/scilog/issues/197) ([7cc0b25](7cc0b25))
* initalize touchedAt on logbook creation ([paulscherrerinstitute#461](https://github.com/HayenNico/scilog/issues/461)) ([44a560c](44a560c))
* loop over paginated proposals ([paulscherrerinstitute#459](https://github.com/HayenNico/scilog/issues/459)) ([5e8b22d](5e8b22d))
* patch decorators order ([c4b4e25](c4b4e25))
* selectively return v3 or v4 class ([21ec755](21ec755))
* token_prefix default to empty string ([paulscherrerinstitute#457](https://github.com/HayenNico/scilog/issues/457)) ([1001fed](1001fed))
* use newer python versions ([paulscherrerinstitute#443](https://github.com/HayenNico/scilog/issues/443)) ([38f8731](38f8731))

### Features

* added LogbookMessage ([5b34e95](5b34e95))
* added send_logbook_message ([67d13d2](67d13d2))
* added support for ckeditor marker/pens ([30ec7e7](30ec7e7))
* link on proposalId in scicat-viewer widget ([paulscherrerinstitute#466](https://github.com/HayenNico/scilog/issues/466)) ([26c8d84](26c8d84))
* logbook eln export ([paulscherrerinstitute#455](https://github.com/HayenNico/scilog/issues/455)) ([d2ec35f](d2ec35f))
* **sdk:** add ability to disable auto save ([2cc4c7c](2cc4c7c))
* **sdk:** add option to construct a new logbook message directly ([858b251](858b251))
github-actions Bot pushed a commit to HayenNico/scilog that referenced this pull request Mar 12, 2026
@semantic-release-bot
chore(release): 1.0.0 [skip ci]
1883e56 
# 1.0.0 (2026-03-12)

### Bug Fixes

* add createdBy to readACL as well ([paulscherrerinstitute#462](https://github.com/HayenNico/scilog/issues/462)) ([2856059](2856059))
* add properties to eln export to pass ELN Format CI ([paulscherrerinstitute#467](https://github.com/HayenNico/scilog/issues/467)) ([616385c](616385c))
* add token_prefix option to accomodate be_next ([paulscherrerinstitute#442](https://github.com/HayenNico/scilog/issues/442)) ([2ed44ab](2ed44ab))
* added missing logbook_message file ([a624d3f](a624d3f))
* always get the latest version from the editor before submitting; closes [paulscherrerinstitute#206](https://github.com/HayenNico/scilog/issues/206) ([9e82bb3](9e82bb3))
* bind scilog version ([paulscherrerinstitute#476](https://github.com/HayenNico/scilog/issues/476)) ([751614c](751614c))
* **ci:** use conventionalcommits preset for calculating the new semver ([a42261b](a42261b))
* **deps:** add formidable as direct dependency ([e6fbbd2](e6fbbd2))
* **deps:** update dependency formidable to v2.1.3 [security] ([8360fa9](8360fa9))
* **deps:** update dependency multer to v2 [security] ([e27f6c7](e27f6c7))
* fixed editor style for resized images ([fbb9e91](fbb9e91))
* fixed link for files ([34b0a7b](34b0a7b))
* increased idle time for updates from 1s to 5s; closes [paulscherrerinstitute#197](https://github.com/HayenNico/scilog/issues/197) ([7cc0b25](7cc0b25))
* initalize touchedAt on logbook creation ([paulscherrerinstitute#461](https://github.com/HayenNico/scilog/issues/461)) ([44a560c](44a560c))
* loop over paginated proposals ([paulscherrerinstitute#459](https://github.com/HayenNico/scilog/issues/459)) ([5e8b22d](5e8b22d))
* patch decorators order ([c4b4e25](c4b4e25))
* selectively return v3 or v4 class ([21ec755](21ec755))
* token_prefix default to empty string ([paulscherrerinstitute#457](https://github.com/HayenNico/scilog/issues/457)) ([1001fed](1001fed))
* use newer python versions ([paulscherrerinstitute#443](https://github.com/HayenNico/scilog/issues/443)) ([38f8731](38f8731))

### Features

* added LogbookMessage ([5b34e95](5b34e95))
* added send_logbook_message ([67d13d2](67d13d2))
* added support for ckeditor marker/pens ([30ec7e7](30ec7e7))
* link on proposalId in scicat-viewer widget ([paulscherrerinstitute#466](https://github.com/HayenNico/scilog/issues/466)) ([26c8d84](26c8d84))
* logbook eln export ([paulscherrerinstitute#455](https://github.com/HayenNico/scilog/issues/455)) ([d2ec35f](d2ec35f))
* **sdk:** add ability to disable auto save ([2cc4c7c](2cc4c7c))
* **sdk:** add option to construct a new logbook message directly ([858b251](858b251))
github-actions Bot pushed a commit to udaisingh93/scilog that referenced this pull request Jun 19, 2026
@semantic-release-bot
chore(release): 1.0.0 [skip ci]
267b5e3 
# 1.0.0 (2026-06-19)

### Bug Fixes

* add createdBy to readACL as well ([paulscherrerinstitute#462](https://github.com/udaisingh93/scilog/issues/462)) ([2856059](2856059))
* add properties to eln export to pass ELN Format CI ([paulscherrerinstitute#467](https://github.com/udaisingh93/scilog/issues/467)) ([616385c](616385c))
* add token_prefix option to accomodate be_next ([paulscherrerinstitute#442](https://github.com/udaisingh93/scilog/issues/442)) ([2ed44ab](2ed44ab))
* added missing logbook_message file ([a624d3f](a624d3f))
* always get the latest version from the editor before submitting; closes [paulscherrerinstitute#206](https://github.com/udaisingh93/scilog/issues/206) ([9e82bb3](9e82bb3))
* **api:** add missing ws dependency ([paulscherrerinstitute#568](https://github.com/udaisingh93/scilog/issues/568)) ([283cfcd](283cfcd)), closes [paulscherrerinstitute#567](https://github.com/udaisingh93/scilog/issues/567)
* **api:** build once before starting dev watchers ([paulscherrerinstitute#615](https://github.com/udaisingh93/scilog/issues/615)) ([78efd61](78efd61))
* **api:** emit contentSize as string per ELN spec ([paulscherrerinstitute#609](https://github.com/udaisingh93/scilog/issues/609)) ([c9bb86b](c9bb86b)), closes [paulscherrerinstitute#608](https://github.com/udaisingh93/scilog/issues/608)
* **api:** route subsnippet relations via unscoped repo ([paulscherrerinstitute#630](https://github.com/udaisingh93/scilog/issues/630)) ([dc97d02](dc97d02)), closes [paulscherrerinstitute#629](https://github.com/udaisingh93/scilog/issues/629)
* **api:** run tests inside the dev container ([paulscherrerinstitute#603](https://github.com/udaisingh93/scilog/issues/603)) ([eb70ac1](eb70ac1)), closes [paulscherrerinstitute#601](https://github.com/udaisingh93/scilog/issues/601)
* bind scilog version ([paulscherrerinstitute#476](https://github.com/udaisingh93/scilog/issues/476)) ([751614c](751614c))
* **ci:** use conventionalcommits preset for calculating the new semver ([a42261b](a42261b))
* **deps:** add formidable as direct dependency ([e6fbbd2](e6fbbd2))
* **deps:** update dependency formidable to v2.1.3 [security] ([8360fa9](8360fa9))
* **deps:** update dependency jsdom to v29 ([7ed7088](7ed7088))
* **deps:** update dependency jsdom to v29.0.1 ([79f3f9c](79f3f9c))
* **deps:** update dependency jsdom to v29.0.2 ([paulscherrerinstitute#575](https://github.com/udaisingh93/scilog/issues/575)) ([afb998f](afb998f))
* **deps:** update dependency multer to v2 [security] ([e27f6c7](e27f6c7))
* **deps:** update dependency pm2 to v6 ([90fa41d](90fa41d))
* **deps:** update dependency puppeteer to v24 ([15dcfed](15dcfed))
* **deps:** update dependency tar to v7.5.13 ([da6daa3](da6daa3))
* **deps:** update loopback monorepo ([bef5f8a](bef5f8a))
* **deps:** update loopback monorepo ([paulscherrerinstitute#584](https://github.com/udaisingh93/scilog/issues/584)) ([9e52b3d](9e52b3d))
* **deps:** upgrade LB 4 packages and Node to 22 ([af0ffc9](af0ffc9))
* **deps:** upgrade tar to v7.5.11 ([0fd4116](0fd4116)), closes [microsoft/TypeScript#21745](microsoft/TypeScript#21745)
* fixed editor style for resized images ([fbb9e91](fbb9e91))
* fixed link for files ([34b0a7b](34b0a7b))
* increased idle time for updates from 1s to 5s; closes [paulscherrerinstitute#197](https://github.com/udaisingh93/scilog/issues/197) ([7cc0b25](7cc0b25))
* initalize touchedAt on logbook creation ([paulscherrerinstitute#461](https://github.com/udaisingh93/scilog/issues/461)) ([44a560c](44a560c))
* loop over paginated proposals ([paulscherrerinstitute#459](https://github.com/udaisingh93/scilog/issues/459)) ([5e8b22d](5e8b22d))
* patch decorators order ([c4b4e25](c4b4e25))
* remove redundant pretest from the test command ([paulscherrerinstitute#535](https://github.com/udaisingh93/scilog/issues/535)) ([2d6f84e](2d6f84e))
* revert to workdir for backward compatibility ([paulscherrerinstitute#582](https://github.com/udaisingh93/scilog/issues/582)) ([1a017d4](1a017d4))
* **sdk:** scilog.new forwards parent to LogbookMessage ([paulscherrerinstitute#534](https://github.com/udaisingh93/scilog/issues/534)) ([652deeb](652deeb))
* selectively return v3 or v4 class ([21ec755](21ec755))
* token_prefix default to empty string ([paulscherrerinstitute#457](https://github.com/udaisingh93/scilog/issues/457)) ([1001fed](1001fed))
* use newer python versions ([paulscherrerinstitute#443](https://github.com/udaisingh93/scilog/issues/443)) ([38f8731](38f8731))
* use types from ro-crate library ([paulscherrerinstitute#587](https://github.com/udaisingh93/scilog/issues/587)) ([6e1f719](6e1f719))

### Features

* added LogbookMessage ([5b34e95](5b34e95))
* added send_logbook_message ([67d13d2](67d13d2))
* added support for ckeditor marker/pens ([30ec7e7](30ec7e7))
* **api:** add url to sdPublisher Organization ([paulscherrerinstitute#607](https://github.com/udaisingh93/scilog/issues/607)) ([e9ab705](e9ab705)), closes [paulscherrerinstitute#600](https://github.com/udaisingh93/scilog/issues/600)
* **api:** surface logbook author on ELN export root ([paulscherrerinstitute#622](https://github.com/udaisingh93/scilog/issues/622)) ([ac6be72](ac6be72)), closes [paulscherrerinstitute#617](https://github.com/udaisingh93/scilog/issues/617)
* **eln:** add content size and sha256 to file snippet and ro-crate entity ([paulscherrerinstitute#514](https://github.com/udaisingh93/scilog/issues/514)) ([76db6a6](76db6a6))
* link on proposalId in scicat-viewer widget ([paulscherrerinstitute#466](https://github.com/udaisingh93/scilog/issues/466)) ([26c8d84](26c8d84))
* logbook eln export ([paulscherrerinstitute#455](https://github.com/udaisingh93/scilog/issues/455)) ([d2ec35f](d2ec35f))
* **scicat-widget:** add functionality to link logbook to dataset ([paulscherrerinstitute#590](https://github.com/udaisingh93/scilog/issues/590)) ([9cf4c26](9cf4c26))
* **sdk:** add ability to disable auto save ([2cc4c7c](2cc4c7c))
* **sdk:** add option to construct a new logbook message directly ([858b251](858b251))
* **sdk:** add support for specifying the image dimensions ([paulscherrerinstitute#539](https://github.com/udaisingh93/scilog/issues/539)) ([78c52ff](78c52ff))

### Reverts

* Revert "chore(api): move rs.initiate to post_start ([paulscherrerinstitute#576](https://github.com/udaisingh93/scilog/issues/576))" ([paulscherrerinstitute#599](https://github.com/udaisingh93/scilog/issues/599)) ([edd7acf](edd7acf))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@minottic minottic minottic approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@omkar-ethz @minottic