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

docs: add repository input default

Browse source
This commit is contained in:
Peter Evans 2020-09-25 14:42:31 +09:00
parent 68960cdd4c
commit 9db4dd4244
2 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -23,11 +23,11 @@ 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 | | | `password` | (**required**) Docker Hub password. | |
| `repository` | (**required**) Docker Hub repository in the format `<namespace>/<name>` | | | `repository` | Docker Hub repository in the format `<namespace>/<name>`. | `github.repository` |
| `readme-filepath` | Path to the repository readme. | `./README.md` | | `readme-filepath` | Path to the repository readme. | `./README.md` |
#### Optionally specifying the file path #### Specifying the file path
The action assumes that there is a file called `README.md` located at the root of the repository. The action assumes that there is a file called `README.md` located at the root of the repository.
If this is not the case the path can be specified with the `readme-filepath` input. If this is not the case the path can be specified with the `readme-filepath` input.

9
action.yml
View file

@ -9,10 +9,13 @@ inputs:
description: Docker Hub password description: Docker Hub password
required: true required: true
repository: repository:
description: Docker Hub repository in the format `<namespace>/<name>` description: >
required: true Docker Hub repository in the format `<namespace>/<name>`
Default: `github.repository`
readme-filepath: readme-filepath:
description: Path to the repository readme. Defaults to `./README.md`. description: >
Path to the repository readme
Default: `./README.md`
runs: runs:
using: 'node12' using: 'node12'
main: 'dist/index.js' main: 'dist/index.js'