Skip to content

Commit

Permalink
annotations: restrict character set of ref.name values
Browse files Browse the repository at this point in the history
URI are standard enough, though % opens it a bit too much.
After much discussion we're going to keep it as close to the docker tag
as possible but with +, @ and /
reference: opencontainers/image-spec#671 (comment)

Fixes #599

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
  • Loading branch information
7c00d committed Jul 22, 2026
1 parent 08c484d commit bdf0d97
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion annotations.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,16 @@ This specification defines the following annotation keys, intended for but not l
* **org.opencontainers.image.revision** Source control revision identifier for the packaged software.
* **org.opencontainers.image.vendor** Name of the distributing entity, organization or individual.
* **org.opencontainers.image.licenses** License(s) under which contained software is distributed as an [SPDX License Expression][spdx-license-expression].
* **org.opencontainers.image.ref.name** Name of the reference for a target (string). SHOULD only be considered valid when on descriptors on `index.json` within [image layout](image-layout.md).
* **org.opencontainers.image.ref.name** Name of the reference for a target (string).
* SHOULD only be considered valid when on descriptors on `index.json` within [image layout](image-layout.md).
* Character set of the value SHOULD conform to alphanum of `A-Za-z0-9` and separator set of `-._:@/+`
* An EBNF'esque grammar + regular expression like:
```
ref := component ["/" component]*
component := alphanum [separator alphanum]*
alphanum := /[A-Za-z0-9]+/
separator := /[-._:@+]/ | "--"
```
* **org.opencontainers.image.title** Human-readable title of the image (string)
* **org.opencontainers.image.description** Human-readable description of the software packaged in the image (string)

Expand Down

0 comments on commit bdf0d97

Please sign in to comment.