goharbor / harbor-cli

[Sandbox] Official Harbor CLI
Apache License 2.0
41 stars 45 forks source link

Listing Harbor CLI on ArtifactHub #231

Open Vad1mo opened 3 weeks ago

Vad1mo commented 3 weeks ago

ArtifactHub is a popular place to discover helm charts but also container images. CNCF has its presence on ArtifactHub

https://artifacthub.io/packages/search?org=harbor&sort=relevance&page=1

I was able to add the image for ArtifactHub to crawl. However there is a problem as the image does not have the right metadata.

We encountered some errors while tracking repository harbor-cli.

Some or all of these errors may be just warnings, and it's possible that your packages have been still indexed properly. However, it'd be great if you can take a look at them just in case there is something missing or failing in your repository that may affect how your content is displayed on Artifact Hub.


error preparing package (tag: latest): 3 errors occurred:

* required metadata field not provided: org.opencontainers.image.created

* required metadata field not provided: org.opencontainers.image.description

* required metadata field not provided: io.artifacthub.package.readme-url

Task would be to extend the Dagger workflow and add the minimum required and recommended metadata

https://artifacthub.io/docs/topics/repositories/container-images/

key required description
io.artifacthub.package.readme-url yes url of the readme file (in markdown format) for this package version. Please make sure it points to a raw markdown document, not HTML
org.opencontainers.image.created yes date and time on which the image was built (RFC3339)
org.opencontainers.image.description yes a short description of the package
org.opencontainers.image.documentation no url to get documentation on the image
org.opencontainers.image.source no url to get source code for building the image
org.opencontainers.image.title no name of the package nicely formatted
org.opencontainers.image.url no url to find more information on the image
org.opencontainers.image.vendor no name of the distributing entity, organization or individual
org.opencontainers.image.version no version of the packaged software
io.artifacthub.package.alternative-locations no alternative locations where this image is hosted. They can be provided as a comma separated list of images urls
io.artifacthub.package.category no category of the package (ai-machine-learning, database, integration-delivery, monitoring-logging, networking, security, storage, streaming-messaging or skip-prediction)
io.artifacthub.package.contains-security-updates no boolean that indicates if this image version contains security updates
io.artifacthub.package.deprecated no boolean that indicates if this image version is deprecated
io.artifacthub.package.keywords no a list of comma separated keywords about this image
io.artifacthub.package.license no SPDX identifier of the package license
io.artifacthub.package.logo-url no url of the logo image
io.artifacthub.package.maintainers no json string with an array of maintainers. Example: [{"name":"maintainer","email":"maintainer@email.com"}]
io.artifacthub.package.prerelease no boolean that indicates if this image version is a pre-release

Also some additional references.

documentation, logo etc.