bf1942/dockerhub-description
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: remove error when content limit exceeded

Browse Source
This commit is contained in:
Peter Evans
2022-08-18 12:17:06 +09:00
parent 22ceabb390
commit afa309ec72
4 changed files with 8 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -23,9 +23,14 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea
| `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/) with `read/write/delete` scope. | |
| `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. | |
| `readme-filepath` | Path to the repository readme. | `./README.md` |
#### Content limits
DockerHub has content limits, which if exceeded will result in the content being automatically truncated.
The readme content is limited to 25,000 bytes, and `short-description` is limited to 100 characters.
#### Specifying the file path
The action assumes that there is a file called `README.md` located at the root of the repository.