pipe-update-docker-hub-readme

Updates the readme file on DockerHub or any compatible API.

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

Flags

CLI

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

DockerHub

Flag / Environment	Description	Type	Required	Default
`$DOCKER_USERNAME`	DockerHub username for updating the readme.	`String`	`true`
`$DOCKER_PASSWORD`	DockerHub password for updating the readme.	`String`	`true`
`$DOCKER_HUB_ADDRESS`	HTTP address for the DockerHub compatible service.	`String`	`false`	https://hub.docker.com/v2/repositories

Readme

Flag / Environment	Description	Type	Required	Default
`$DOCKER_IMAGE_NAME` `$README_REPOSITORY`	Repository for applying the readme on.	`String`	`false`
`$README_FILE`	Readme file for the given repository.	`String`	`false`	README.md
`$README_DESCRIPTION`	Short description to display on DockerHub.	`String`	`false`
`$README_MATRIX`	Matrix of multiple README files to update.	`String` `json([]struct { repository: string, file: string, description?: string })`	`false`