BioContainers / specs

BioContainers specifications
http://biocontainers.pro
Apache License 2.0
49 stars 12 forks source link

[WIP] Example usage of the Label Schema standard #87

Closed mr-c closed 5 years ago

mr-c commented 6 years ago

See http://label-schema.org/rc1/

base.image became base-image for consistency with their convention

mr-c commented 6 years ago

@ypriverol Why did you close this?

ypriverol commented 6 years ago

@mr-c we have decided for compatibility with conda to use the convention _ for labels with more than one letter. This will give us incredible capabilities to reuse code for conda recipes and Dockerfiles. Here, how conda define the names https://conda.io/docs/user-guide/tasks/build-packages/define-metadata.html . This is more strategically for us because a lot of our containers are produced automatically from conda packages. But you write, we should discuss here this idea, and vote. Lets see the opinion from @jmchilton @hmenager @osallou @prvst and @bgruening

mr-c commented 6 years ago

@ypriverol Was there a vote? I missed this discussion.

mr-c commented 6 years ago

@ypriverol Okay. Then we can include the conda version for backwards compatibility in addition to the standardized label-schema.org version.

stain commented 6 years ago

https://docs.docker.com/config/labels-custom-metadata/ says

Authors of third-party tools should prefix each label key with the reverse DNS notation of a domain they own, such as com.example.some-label.

I think we should reuse the suggested org.label-schema labels where appropriate, and add pro.biocontainers (or perhaps better io.conda) labels for whatever is missing. Custom labels without namespace like software.version sounds like asking for trouble.

ypriverol commented 6 years ago

@mr-c @stain is this version aligned with label-schema https://github.com/ypriverol/specs/blob/master/container-specs.md ?

ypriverol commented 6 years ago

@osallou can you give your opinion here, also @prvst

mr-c commented 6 years ago

@mr-c @stain is this version aligned with label-schema https://github.com/ypriverol/specs/blob/master/container-specs.md ?

No, that's what this PR was trying to do :-)

osallou commented 6 years ago

Namespacing label is only an advise, it is not mandatory at all. It is to ease rhe search for search with containers from different sources. I would keep 'short' labels for simplicity

Le mer. 14 févr. 2018 17:23, Yasset Perez-Riverol notifications@github.com a écrit :

@osallou https://github.com/osallou can you give your opinion here, also @prvst https://github.com/prvst

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/BioContainers/specs/pull/87#issuecomment-365660874, or mute the thread https://github.com/notifications/unsubscribe-auth/AA-gYr38PCDRllerMQRkI9oJh2dLilIcks5tUwhtgaJpZM4P1t92 .

ypriverol commented 6 years ago

Hi @stain @mr-c I have been reading about org.label-schema and it will mean that we need to really change all of our labels. My suggestion, for now, is to change only some fields to standardize all name conventions (https://github.com/BioContainers/specs/pull/91) and then open a completely new thread to move all of our fields into org.label-schema . Please @mr-c review my PR because some other topics more relevant to cwl needs to be reviewed like: entrypoint, user, working-directory.