documentings envs as comments

This commit is contained in:
Chase Pierce 2020-06-29 22:29:36 -06:00
parent b93f6fad1d
commit 852d8b4b1f

View file

@ -1,19 +1,22 @@
name: 'Docker Hub Description' name: 'Docker Hub Description'
author: 'Peter Evans' author: 'Peter Evans'
description: 'An action to update a Docker Hub repository description from README.md' description: 'An action to update a Docker Hub repository description from README.md'
# env:
# DOCKERHUB_USERNAME:
# description: Username to login to Docker Hub. Aliases: DOCKER_USERNAME
# required: false
# DOCKERHUB_PASSWORD:
# description: Password to login to Docker Hub. Aliases: DOCKER_PASSWORD
# required: false
# DOCKERHUB_REPOSITORY:
# description: Explicit Docker Hub repository name. Aliases: DOCKER_REPOSITORY, GITHUB_REPOSITORY
# required: false
# README_FILEPATH:
# description: Path to the repository readme.
# default: ./README.md
runs: runs:
using: 'docker' using: 'docker'
image: 'docker://peterevans/dockerhub-description:2.1.1' image: 'docker://peterevans/dockerhub-description:2.1.1'
branding: branding:
icon: 'upload' icon: 'upload'
color: 'blue' color: 'blue'
inputs:
dockerhubUsername:
description: Username to login to Docker Hub. Aliases: DOCKER_USERNAME
required: false
dockerhubPassword:
description: Password to login to Docker Hub. Aliases: DOCKER_PASSWORD
required: false
dockerhubRepository:
description: Explicit Docker Hub repository name. Aliases: DOCKER_REPOSITORY, GITHUB_REPOSITORY
required: false