Better document implicit defaults of `labels`/`annotations`
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- docker, github-actions, typescript
- Domain
- devops, documentation
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.
Description
Description
The relevant source is reasonably straight-forward to interpret and unlikely to change:
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:
- https://github.com/docker/metadata-action/issues/584
- https://github.com/docker/metadata-action/issues/585
- https://github.com/docker/metadata-action/issues/591
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.
- Dominant language
- TypeScript
- Stars
- 1.1k
- Forks
- 160
- Avg merge
- 4d 17h
- Merged PRs (30d)
- 12
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from docker/metadata-action
-
kind/enhancement status/triage
Difficulty 3/5 1-2 days Newbie friendliness 65/100
docker/metadata-action#709 ·
-
kind/enhancement status/triage
Difficulty 3/5 1-2 days Newbie friendliness 64/100
docker/metadata-action#593 · 1 comment ·
-
kind/enhancement status/triage
Difficulty 5/5 Over a week Newbie friendliness 35/100
docker/metadata-action#591 ·
-
kind/enhancement status/triage
Difficulty 3/5 1-2 days Newbie friendliness 48/100
docker/metadata-action#585 ·
-
kind/enhancement status/triage
Difficulty 3/5 1-2 days Newbie friendliness 35/100
docker/metadata-action#584 · 1 reaction ·
All issues in docker/metadata-action
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
danielmiessler/LifeOS#2218 ·