Skip to content

Adjustments for current mechanism of attaching metadata representation of ARCs #30

@kMutagene

Description

@kMutagene

Currently, 4 files are attached via the arc_json stage, see https://git.nfdi4plants.org/muehlhaus/ArcPrototype/-/jobs/8024.

  • arc-summary.md
  • arc-ro-crate-metadata.json
  • arc-isa.json
  • arc.json

All of these files are then pushed to a package in the ARC's package registry called isa_arc_json, which is not versioned, see https://git.nfdi4plants.org/muehlhaus/ArcPrototype/-/packages

I do not think we want to leave this mechanism as-is. I understand that some of it needs to backwards-compatible. I have some suggestions:

  • create one named package per file. That way, we can keep the isa_arc_json package, but it can then only contain actual isa json files:
  • rename the pipeline stage and job name. It is creating more than ar_json or isa_json. I would suggest calling the stage arc_metadata and the job Create ARC metadata
  • establish a versioning of these packages. As a first step, i would not touch major/minor/patch, but simply add the repo commit hash as build metadata to the semver build metadata suffix, e.g. 0.0.1+<commit-hash> (https://semver.org/#spec-item-10). further versioning of the arc should be user driven i think, and we currently have no mechanisms for that IIRC.

thoughts @muehlhaus @HLWeil @j-bauer ?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions