biocompute-objects / BCO_Documentation

Repository for documentation to support the IEEE 2791-2020 standard. Please see our home page for communications/publications:
http://biocomputeobject.org/
BSD 3-Clause "New" or "Revised" License
16 stars 12 forks source link

Refine github extension keys #21

Closed stain closed 6 years ago

stain commented 6 years ago

The github extension is only explained by example.

The two keys github_repository and github_URI are not explained and seem to be partially overlapping. The camel_Case is also inconsistent.

Given that these are URLs I think the extension should support any source control repository, not just github.com, perhaps something like:

"extension_domain":{
  "scm_extension": {
    "scm_repository": "https://github.com/example/repo1",
    "scm_type": "git",
    "scm_branch": "c9ffea0b60fa3bcf8e138af7c99ca141a6b8fb21",
    "scm_path": "workflow/hive-viral-mutation-detection.cwl",
    "scm_preview": "https://github.com/example/repo1/blob/c9ffea0b60fa3bcf8e138af7c99ca141a6b8fb21/workflow/hive-viral-mutation-detection.cwl"
}

Here's how Maven defines it's scm metadata.

stain commented 6 years ago

Marked as discuss - we can keep this simple or general (or something in-between)

mr-c commented 6 years ago

I agree, we shouldn't bake in a commercial third party into the BCO spec/standard

mr-c commented 6 years ago

Thanks for clarifying, @HadleyKing but I think the example should be updated to match Stian's suggestion.

HadleyKing commented 6 years ago

github_extension to scm_extension