update documentation and update setup docker action

This commit is contained in:
2026-07-22 09:02:27 +02:00
parent 647a3b5e5a
commit 8c2783f4ef
3 changed files with 59 additions and 3 deletions
+23 -1
View File
@@ -3,7 +3,29 @@ This action is a wrapper around `dockerhub-description` that installs the requir
The wrapper then invokes the upstream action using the same inputs, making it a drop-in replacement.
usage:
## Inputs
This action supports the same inputs as the upstream [`dockerhub-description`](https://github.com/peter-evans/dockerhub-description) action.
| Input | Required | Description |
|---------|----------|-------------|
| `username` | Yes | Docker Hub username. |
| `password` | Yes | Docker Hub password or access token. |
| `repository` | Yes | Docker Hub repository name (`username/repository`). |
| `short-description` | No | Repository short description. |
| `readme-filepath` | No | Path to the README file to publish. Defaults to `./README.md`. |
| `enable-url-completion` | No | Enable automatic URL completion in the README content. |
For a complete and up-to-date list of supported inputs, refer to the upstream project documentation:
- [`dockerhub-description`](https://github.com/peter-evans/dockerhub-description)
## Usage
```yaml
name: Update docker hub description