search

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

"bco_spec_version" as a URL? #7

Closed HadleyKing closed 6 years ago

HadleyKing commented 6 years ago

Should the "bco_spec_version" field be expressed as a URL to the RELEASE of the version used to draft it? For example: 

"bco_spec_version": "v1.1-draft1"

Becomes:

"bco_spec_version": "https://github.com/biocompute-objects/BCO_Specification/releases/tag/v1.2"
stain commented 6 years ago

Yes, that is a very good idea, but it should be a permalink (e.g. using http://w3id.org/) rather than straight onto GitHub as those URLs are fragile.

Here's how we did this for CWLProv profiles: https://w3id.org/cwl/prov/0.6.0

We use semantic versioning where we document in advance what we think is a major.minor.patch level 'change'.

How we declare it inside the Research Object manifest JSON:

 "conformsTo": "https://w3id.org/cwl/prov/0.6.0",

(that is conformsTo from Dublin Core Terms)

HadleyKing commented 6 years ago

@stain This seems like a great idea but I am not sure I did it correctly.
Can you check it out?

w3id.org/biocompute/spec/v1.2 Also see the repo for w3idin BioCompute. I think I set it up so it is extensible, like you suggested. The v1.2 will have its own special link because it follows an unconventional naming convention. Later we can add biocompute/example/* or others...

HadleyKing commented 5 years ago

@kee007ney

HadleyKing commented 5 years ago

@stain Maybe this is in the documentation and I did not see it but what is to prevent from someone issuing a commit that has a malicious redirect?