Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] RO-Crate export missing MUST fields #472

Open
floWetzels opened this issue Nov 7, 2024 · 10 comments
Open

[BUG] RO-Crate export missing MUST fields #472

floWetzels opened this issue Nov 7, 2024 · 10 comments
Assignees
Labels
Type: Feature Request This item is confirmed by the maintainers to be a request for a new feature

Comments

@floWetzels
Copy link
Collaborator

The investigation object in the RO-Crate export does not necessarily have a license and name field, however, they are required by the RO-Crate specification.

Could the gitlab CI detect an existing license and insert it into the arc export command? @j-bauer

@github-actions github-actions bot added the Status: Needs Triage This item is up for investigation. label Nov 7, 2024
@feserm
Copy link

feserm commented Nov 7, 2024

There are some available APIs to query against:

When searching for license scanning and gitlab this popped up:

@j-bauer
Copy link

j-bauer commented Nov 11, 2024

Yes, this can be done in the CI-Pipeline. Can you point me to an example RO-Crate containing a license?

@HLWeil
Copy link
Member

HLWeil commented Nov 18, 2024

I think we don't have any example yet, @j-bauer. But as I said I could insert this as an argument in the arc-export tool, so you would only need to provide this when calling the export

@HLWeil HLWeil added Type: Feature Request This item is confirmed by the maintainers to be a request for a new feature and removed Status: Needs Triage This item is up for investigation. labels Nov 18, 2024
@HLWeil HLWeil moved this to Ready in ARCStack Nov 18, 2024
@HLWeil
Copy link
Member

HLWeil commented Jan 23, 2025

name part done but license missing? @floWetzels

@floWetzels
Copy link
Collaborator Author

Correct, PR #488 changed headline to name in Investigations. Licenses are still not handled at all, as far as I know.

I guess we should also change headline to name for studies for consistency. Also, studies can be seen as their own datasets, so I guess it makes sense for them to have a name on their own. There is no field in assays though that can be mapped to name. What do you think, @HLWeil?

@HLWeil
Copy link
Member

HLWeil commented Jan 23, 2025

Yup makes sense to change them to name 👍

Would leave the Assay as is atm, maybe we actually align it more with the study, see nfdi4plants/ARC-specification#86

@kMutagene
Copy link
Member

kMutagene commented Feb 24, 2025

Copying my comment from the related discussion thread

I think we can slowly introduce licensing to ARCs in a few steps:

  1. To produce valid RO-crates in the short term, just use a "All rights reserved by the authors" text value per default. As repositories >without a LICENSE file are per default 'ALL RIGHTS RESERVED' licensed anyways, this does not break anything and makes something that has been implicit so far more explicit.
  2. Make license a mandatory property on the Investigation profile mirroring the requirements of the RO-crate base spec
  3. Update the ARC Scaffold specs with a way to include (optional?) licensing, e.g. via a LICENSE file
  4. enable parsing, recognizing, and writing licenses and exporting them with correct identifiers

I think 1 is easy to solve in this repo right now, 2-3 will take some revision cycles as it changes specs, and 4. is a little more effort implementation-wise in this repo.

@kMutagene
Copy link
Member

kMutagene commented Feb 25, 2025

Correct, PR #488 changed headline to name

In the future, please first update the profile, i am currently aggregating needed changes on the profile and specs, and the codebase being ahead of the profile is something i did not expect.

@floWetzels
Copy link
Collaborator Author

Correct, PR #488 changed headline to name

In the future, please first update the profile, i am currently aggregating needed changes on the profile and specs, and the codebase being ahead of the profile is something i did not expect.

That's not the case though, see nfdi4plants/isa-ro-crate-profile#36

@kMutagene
Copy link
Member

kMutagene commented Feb 26, 2025 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Feature Request This item is confirmed by the maintainers to be a request for a new feature
Projects
Status: Ready
Development

No branches or pull requests

5 participants