actions/dockerhub-description
actions/dockerhub-description
3
0
Fork 0
mirror of https://github.com/peter-evans/dockerhub-description.git synced 2024-11-24 13:09:33 +01:00
Code Issues Projects Activity Pipelines

docs: add pat scope details

Browse source
This commit is contained in:
Peter Evans 2022-07-21 14:26:40 +09:00
parent 5edfa5bd9e
commit 22ceabb390
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -21,7 +21,7 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea
| Name | Description | Default | | Name | Description | Default |
| --- | --- | --- | | --- | --- | --- |
| `username` | (**required**) Docker Hub username. If updating a Docker Hub repository belonging to an organization, this user must have `Admin` permissions for the repository. | | | `username` | (**required**) Docker Hub username. If updating a Docker Hub repository belonging to an organization, this user must have `Admin` permissions for the repository. | |
| `password` | (**required**) Docker Hub password or [Personal Access Token](https://docs.docker.com/docker-hub/access-tokens/). | | | `password` | (**required**) Docker Hub password or [Personal Access Token](https://docs.docker.com/docker-hub/access-tokens/) with `read/write/delete` scope. | |
| `repository` | Docker Hub repository in the format `<namespace>/<name>`. | `github.repository` | | `repository` | Docker Hub repository in the format `<namespace>/<name>`. | `github.repository` |
| `short-description` | Docker Hub repository short description. Input exceeding 100 characters will be truncated. | | | `short-description` | Docker Hub repository short description. Input exceeding 100 characters will be truncated. | |
| `readme-filepath` | Path to the repository readme. | `./README.md` | | `readme-filepath` | Path to the repository readme. | `./README.md` |

2
action.yml
View file

@ -6,7 +6,7 @@ inputs:
description: Docker Hub username description: Docker Hub username
required: true required: true
password: password:
description: Docker Hub password or Personal Access Token description: Docker Hub password or Personal Access Token with read/write/delete scope
required: true required: true
repository: repository:
description: > description: >