GitHub Community
-
|
The GitHub container registry is great! I’ve managed to publish my containers with the provided GitHub workflow. However, when I look at my container’s package page, the “package description” is empty – despite my project’s README.md. I haven’t been able to figure out a way to provide a description. I tried setting some metadata in my Dockerfile, but that didn’t work. I can’t find any option to edit the description from package settings. So how am I supposed to edit my container’s description? Thanks! |
Beta Was this translation helpful? Give feedback.
Replies: 9 comments 1 reply
-
|
That’s great to hear! 🎉 We’re working on better representing your README at the container page view. For now you can set a smaller description via a Docker label which will show up on the container page. Add the following label to your Or you can also add this label at build time: |
Beta Was this translation helpful? Give feedback.
-
|
Not work at all! |
Beta Was this translation helpful? Give feedback.
-
|
That did it, thanks! |
Beta Was this translation helpful? Give feedback.
-
|
Is there documentation anywhere for which labels are recognized for which purposes? I’ve seen you recommend them in a bunch of posts here, but I can’t find any of them on docs.github.com. The Open Containers spec describes a bunch of annotations, but naturally doesn’t tell me which are used by GHCR and how. It would be very helpful to have a summary. 🙂 |
Beta Was this translation helpful? Give feedback.
-
|
New docs are up for the docker labels required to connect to a repo. We haven’t changed the label, it’s still the |
Beta Was this translation helpful? Give feedback.
-
|
Hi @clarkbw, In your example you mentioned When you say
How short you mean? What is the size limit of the string? |
Beta Was this translation helpful? Give feedback.
-
|
Most labels (description included) are limited to |
Beta Was this translation helpful? Give feedback.
-
|
I opened an issue with the docs repo to get this created and it has the details on the other LABELs which can be used. Document all the GHCR labels which can be used · Issue #2617 · github/docs · GitHub |
Beta Was this translation helpful? Give feedback.
-
|
Hey! This is great :slight_smile: Is there a way to make this work for Maven packages as well? |
Beta Was this translation helpful? Give feedback.
-
|
No support for Maven yet but eventually our Maven service will be updated to use the new platform the Container registry is using now. At that time we should be able to better support operations like what you’re asking for. |
Beta Was this translation helpful? Give feedback.
That’s great to hear! 🎉
We’re working on better representing your README at the container page view. For now you can set a smaller description via a Docker label which will show up on the container page.
Add the following label to your
Dockerfile:Or you can also add this label at build time: