Sign inSign up

kokuwaio/dockerhub-metadata

By kokuwaio

Updated about 1 hour ago

A WoodpeckerCI plugin to write metadata to DockerHub repositories.

Image
Integration & delivery
Developer tools
0

3.3K

kokuwaio/dockerhub-metadata repository overview

DockerHub Metadata WoodpeckerCI Plugin

pulls size dockerfile license prs issues

A WoodpeckerCI plugin to write metadata to DockerHub repositories.
Also usable with Gitlab, Github or locally, see examples for usage.

Features

  • set full description in repository from local file
  • set short description in repository from settings
  • set categories for repository

Example

Woodpecker:

steps:
  dockerhub:
    depends_on: []
    image: kokuwaio/dockerhub-metadata
    settings:
      repository: kokuwaio/example-image
      description-short: This image does that!
      categories: [developer-tools, integration-and-delivery]
      username: {from_secret: DOCKERHUB_USERNAME}
      password: {from_secret: DOCKERHUB_PASSWORD}
    when:
      event: push
      branch: main
      path: README.md

Gitlab: (using script is needed because of https://gitlab.com/gitlab-org/gitlab/-/issues/19717)

dockerhub:
  needs: []
  stage: deploy
  image:
    name: kokuwaio/dockerhub-metadata
    entrypoint: [""]
  script: [/usr/local/bin/entrypoint.sh]
  variables:
    PLUGIN_REPOSITORY: kokuwaio/example-image
    PLUGIN_DESCRIPTION_SHORT: This image does that!
    PLUGIN_CATEGORIES: developer-tools,integration-and-delivery
  rules:
    - if: $CI_PIPELINE_SOURCE == "push"
      changes: [README.md]

Settings

Settings NameEnvironmentDefaultDescription
repositoryPLUGIN_REPOSITORYnoneRepository to update with metadata, e.g. kokuwaio/example
description-shortPLUGIN_DESCRIPTION_SHORTnoneShort description for repository.
description-filePLUGIN_DESCRIPTION_FILEREADME.mdFile to read full description from
categoriesPLUGIN_CATEGORIES[]List of categories to set (maximum 3)
usernamePLUGIN_USERNAMEnoneUsername for Dockerhub login
passwordPLUGIN_PASSWORDnonePassword for Dockerhub login, PAT is not supported!

Tag summary

Content type

Image

Digest

sha256:4966c2688

Size

11.8 MB

Last updated

about 1 hour ago

docker pull kokuwaio/dockerhub-metadata