Use Case: Record Git repository, release tag/version, and dependencies within a workflow description inside RO-Crate

[agbeltran]

The use case is: As a workflow developer, I want to record what git repository and release tag/version of a tool was used within the workflow, as well as its dependencies, so that I can reproduce a specific version of the execution.

@stain recommended to submit an issue, so I think there is no standard way to do this at the moment? Do let me know otherwise. Thanks

[jmfernandez]

What we are doing in WfExS-backend when a Workflow Run RO-Crate is generated is using both codeRepository, identifier, url and version, in order to give chances to different consumers of the RO-Crate:

• In codeRepository we are providing the git repository, but not the branch/commit: https://github.com/ResearchObject/workflow-run-crate/blob/78101e2b8b8e1e8390b48bc915c9623069b0ede7/docs/examples/WfExS-backend/wombat-pipelines_provenance/ro-crate-metadata.json#L798

• In identifier we are providing a built identifier following the pseudo git+https scheme understood by pip. This one includes the branch/commit: https://github.com/ResearchObject/workflow-run-crate/blob/78101e2b8b8e1e8390b48bc915c9623069b0ede7/docs/examples/WfExS-backend/wombat-pipelines_provenance/ro-crate-metadata.json#L924

• In url we are providing (whenever it is possible) a web link to the specific branch / commit: https://github.com/ResearchObject/workflow-run-crate/blob/78101e2b8b8e1e8390b48bc915c9623069b0ede7/docs/examples/WfExS-backend/wombat-pipelines_provenance/ro-crate-metadata.json#L1252

• In version we are only providing the branch/commit: https://github.com/ResearchObject/workflow-run-crate/blob/78101e2b8b8e1e8390b48bc915c9623069b0ede7/docs/examples/WfExS-backend/wombat-pipelines_provenance/ro-crate-metadata.json#L1252

Other properties are needed to locate the relative path to the workflow entry point within the checkout.