add more comments

add more comments to help explain how this action actually works and what it does under the hood. This is not documented anywhere else
pull/48/head
Braxton Beyer 2020-01-22 21:20:58 -05:00 committed by GitHub
parent 8eb149d680
commit 02dd1e4a56
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 1 deletions

View File

@ -2,12 +2,17 @@ name: 'Upload a Build Artifact'
description: 'Upload a build artifact that can be used by subsequent workflow steps'
author: 'GitHub'
inputs:
# A directory will be created with this name and populated with the items in the path below.
# Then it will be compressed into a zip file.
name:
description: 'Artifact name'
required: true
path:
description: 'Directory containing files to upload'
required: true
runs:
# Plugins live on the runner and are only available to a certain set of first party actions.
plugin: 'publish'