From 7990b10a0ca6be1ddd27e4d84e6dbbe788d86662 Mon Sep 17 00:00:00 2001 From: Edward Thomson Date: Thu, 5 Dec 2019 15:43:03 +1100 Subject: [PATCH] Update description (#65) --- README.md | 5 +++-- action.yml | 9 +++++---- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7da0fac..0f00640 100644 --- a/README.md +++ b/README.md @@ -38,8 +38,9 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous # Default: ${{ github.repository }} repository: '' - # Ref to checkout (SHA, branch, tag). For the repository that triggered the - # workflow, defaults to the ref/SHA for the event. Otherwise defaults to master. + # The branch, tag or SHA to checkout. When checking out the repository that + # triggered a workflow, this defaults to the reference or SHA for that event. + # Otherwise, defaults to `master`. ref: '' # Access token for clone repository diff --git a/action.yml b/action.yml index 0914a2f..d21e5f1 100644 --- a/action.yml +++ b/action.yml @@ -1,13 +1,14 @@ name: 'Checkout' -description: 'Checkout a Git repository' +description: 'Checkout a Git repository at a particular version' inputs: repository: description: 'Repository name with owner. For example, actions/checkout' default: ${{ github.repository }} ref: description: > - Ref to checkout (SHA, branch, tag). For the repository that triggered the - workflow, defaults to the ref/SHA for the event. Otherwise defaults to master. + The branch, tag or SHA to checkout. When checking out the repository + that triggered a workflow, this defaults to the reference or SHA for + that event. Otherwise, defaults to `master`. token: description: 'Access token for clone repository' default: ${{ github.token }} @@ -25,4 +26,4 @@ inputs: runs: using: node12 main: dist/index.js - post: dist/index.js \ No newline at end of file + post: dist/index.js