docker / docker/metadata-action

Better document implicit defaults of `labels`/`annotations`

Open
#592 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

kind/enhancement status/triage
Dominant language
TypeScript
Stars
1.1k
Forks
160
Avg merge
4d 17h
Merged PRs (30d)
12

Description

Description

The relevant source is reasonably straight-forward to interpret and unlikely to change:

https://github.com/docker/metadata-action/blob/ed95091677497158a9ff38b314264cd965388d5e/src/meta.ts#L540-L550

NOTE: Presently some of those defaults cannot be easily expressed explicitly (sometimes preferable as visibility for maintainers vs implicit knowledge), but this would be much simpler to document if the following was resolved:

org.opencontainers.image.version in particular has been a common caveat users have tripped up on. More relevant direct documentation on this default could link to the priority attributes section for improved visibility/discovery and thus awareness (instead of encountering it after tags are published). See the last section of my next comment for more info.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read src/meta.ts at lines 540-550 to confirm the implicit defaults for labels and annotations, then review issues 584, 585, and 591 because they may affect how the defaults can be documented. Update the relevant documentation to make the defaults, especially org.opencontainers.image.version, more visible and link to the priority attributes section.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, github-actions, typescript
Domain
devops, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.