cenk1cenk2/pipe-update-docker-hub-readme

•Updated 1 day ago

Updates the README on DockerHub for given repository.

Image

10K+

cenk1cenk2/pipe-update-docker-hub-readme repository overview

Updates the readme file on DockerHub or any compatible API.

pipe-update-docker-hub-readme [FLAGS]

CLI

Flag / Environment	Description	Type	Default
`$LOG_LEVEL`	Define the log level for the application.	`string` `enum("panic", "fatal", "warn", "info", "debug", "trace")`	`"info"`
`$ENV_FILE`	Environment files to inject.	`string[]`

DockerHub

Flag / Environment	Description	Type	Default
`$DOCKER_HUB_USERNAME` `$DOCKERHUB_USERNAME` `$DOCKER_USERNAME`*	DockerHub username for updating the README.	`string`
`$DOCKER_HUB_PASSWORD` `$DOCKERHUB_PASSWORD` `$DOCKER_PASSWORD`*	DockerHub password or personal access token for updating the README.	`string`
`$DOCKER_HUB_ADDRESS`	HTTP address for the DockerHub-compatible service.	`string`	`"https://hub.docker.com/v2/repositories"`

* required

Readme

Flag / Environment	Description	Type	Default
`$DOCKER_HUB_README_REPOSITORY` `$DOCKER_IMAGE_NAME` `$CONTAINER_IMAGE_NAME` `$README_REPOSITORY`	Repository to apply the README to.	`string`
`$DOCKER_HUB_README_FILE` `$README_FILE`	README file for the given repository.	`string`	`"README.md"`
`$DOCKER_HUB_README_DESCRIPTION` `$README_SHORT_DESCRIPTION`	Short description to display on DockerHub.	`string`
`$DOCKER_HUB_README_MATRIX` `$README_MATRIX`	Matrix of multiple README files to update.	`string` `format(json([]struct{ repository: string, file: string, description?: string }))`

Recent tags

Content type

Image

Digest

sha256:e0d9254b9…

Size

8.5 MB

Last updated

1 day ago

docker pull cenk1cenk2/pipe-update-docker-hub-readme