MariaDB / mariadb-docker

Docker Official Image packaging for MariaDB
https://mariadb.org
GNU General Public License v2.0
759 stars 438 forks source link

add oci labels #464

Closed grooverdan closed 1 year ago

grooverdan commented 1 year ago

Closes #436

Reference for labels https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys

grooverdan commented 1 year ago

against https://snyk.io/blog/how-and-when-to-use-docker-labels-oci-container-annotations/:

Custom labels, haven't really considered, org.mariadb.releasenotes might be an option.

Unsure how verbose to go with org.opencontainers.image.description

grooverdan commented 1 year ago

@tianon @yosifkit , I haven't seen anything on guidance for labels/annotations. docker best practices does have a label section, however beyond reverse domain notation for keys not much is mentioned. Do you have any guidance?

Do you want org.opencontainers.image.vendor to contain Docker Library or any other changes?

tianon commented 1 year ago

See https://github.com/docker-library/official-images/issues/3540#issuecomment-530925319, especially:

We don't actively recommend using labels. If an image maintainer wants to have labels, that is fine, but label names should adhere to the image spec: https://github.com/opencontainers/image-spec/blob/v1.0.1/annotations.md