39 lines
1.5 KiB
Markdown
39 lines
1.5 KiB
Markdown
# dockerhub description
|
|
|
|
By default, Gitea runner environments do not include the dependencies required by [dockerhub-description](https://github.com/peter-evans/dockerhub-description).<br/>
|
|
This action is a wrapper around `dockerhub-description` that installs the required dependencies before invoking the upstream action, allowing it to run successfully on Gitea runners.
|
|
|
|
The wrapper then invokes the upstream action using the same inputs, making it a drop-in replacement.
|
|
|
|
|
|
## 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
|
|
uses: https://git.claeyscloud.com/david/gitea-actions/dockerhub-description@main
|
|
with:
|
|
username: username
|
|
password: password
|
|
repository: repo
|
|
``` |