Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LABEL container.version --> LABEL dockerfile.version #118

Closed
kapsakcj opened this issue Jun 2, 2020 · 6 comments
Closed

LABEL container.version --> LABEL dockerfile.version #118

kapsakcj opened this issue Jun 2, 2020 · 6 comments
Labels
enhancement New feature or request

Comments

@kapsakcj
Copy link
Collaborator

kapsakcj commented Jun 2, 2020

LABEL container.version is super vague. It should be LABEL dockerfile.version. Intended for tracking multiple versions of a dockerfile for a single program (and it's single version).

For example if I had to make adjustments to the SPAdes 3.14.1 dockerfile (for which there is only one dockerfile version currently), I would bump to LABEL dockerfile.version=2

@kapsakcj kapsakcj added the enhancement New feature or request label Jun 4, 2020
@erinyoung
Copy link
Contributor

Could you give an example of how you want this to look?

@kapsakcj
Copy link
Collaborator Author

LABEL dockerfile.version="1" for the first iteration of a dockerfile. Then if you had to tweak the dockerfile at a later date, but not change the version of the actual program (SPAdes or whathave you), then I would change it to LABEL dockerfile.version="2" when commiting the edited dockerfile to the repo.

IMO semantic versioning isn't necessary here because I don't expect dockerfiles to change much once they are running smoothly and I would like to keep it simple.

Happy to hear your thoughts on this.

@kapsakcj kapsakcj mentioned this issue Sep 30, 2020
This was referenced Jul 13, 2021
kapsakcj added a commit that referenced this issue Jul 15, 2021
* Bootstrap canu 2.1.1

* Fix PATH location

* Add canu v2.1.1 to Available Image table

* Remove ambiguous 'version' label

See #118 for explanation

* Update contact info

* Abstract canu version to argument

* Correct README usage parameter name to match up-to-date software

* added MillironX to authors/maintainers list

Co-authored-by: Curtis Kapsak <kapsakcj@gmail.com>
@kapsakcj kapsakcj mentioned this issue Sep 28, 2021
@kapsakcj kapsakcj mentioned this issue Feb 8, 2022
12 tasks
@erinyoung
Copy link
Contributor

The label is correct in the template, right?

https://github.com/StaPH-B/docker-builds/blob/master/dockerfile-template/Dockerfile

@kapsakcj , do you think we need to add/change labels?

@kapsakcj
Copy link
Collaborator Author

kapsakcj commented Oct 7, 2022

Yes, the template has the correct LABEL (dockerfile.version).

The only slight change for the template would be something like this, if multiple people are maintainers or authors of the dockerfile:

LABEL maintainer1="Anders Goncalves da Silva"
LABEL maintainer1.email="andersgs@gmail.com"
LABEL maintainer2="Curtis Kapsak"
LABEL maintainer2.email="curtis.kapsak@theiagen.com"

@erinyoung
Copy link
Contributor

I want to ensure that each docker image has the recommended labels, so I added a check in #499.

I had a difficult time adding wildcards when using docker inspect to look at labels, so I'm going to recommend that the first maintainer is maintainer and the nth maintainer is maintainer$n. So the recommendation would look like this:

LABEL maintainer="Anders Goncalves da Silva"
LABEL maintainer.email="andersgs@gmail.com"
LABEL maintainer2="Curtis Kapsak"
LABEL maintainer2.email="curtis.kapsak@theiagen.com"

@kapsakcj kapsakcj mentioned this issue Feb 8, 2023
7 tasks
@erinyoung
Copy link
Contributor

I think we can close this issue now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants