From 9db4dd4244b5b42298a94e21e1f268b378e7f099 Mon Sep 17 00:00:00 2001 From: Peter Evans <18365890+peter-evans@users.noreply.github.com> Date: Fri, 25 Sep 2020 14:42:31 +0900 Subject: [PATCH] docs: add repository input default --- README.md | 6 +++--- action.yml | 9 ++++++--- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 75ac507..dbd767d 100644 --- a/README.md +++ b/README.md @@ -23,11 +23,11 @@ This is useful if you `docker push` your images to Docker Hub. It provides an ea | 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. | | -| `password` | (**required**) Docker Hub password | | -| `repository` | (**required**) Docker Hub repository in the format `/` | | +| `password` | (**required**) Docker Hub password. | | +| `repository` | Docker Hub repository in the format `/`. | `github.repository` | | `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. If this is not the case the path can be specified with the `readme-filepath` input. diff --git a/action.yml b/action.yml index 35cb92a..2525a27 100644 --- a/action.yml +++ b/action.yml @@ -9,10 +9,13 @@ inputs: description: Docker Hub password required: true repository: - description: Docker Hub repository in the format `/` - required: true + description: > + Docker Hub repository in the format `/` + Default: `github.repository` readme-filepath: - description: Path to the repository readme. Defaults to `./README.md`. + description: > + Path to the repository readme + Default: `./README.md` runs: using: 'node12' main: 'dist/index.js'