Read-only mirror — the public repositories of the Forgejo instance, refreshed every 10 minutes. The live instance (fg.dieschoenewolke.de) is reachable only over the VPN; clone here with https://git.dieschoenewolke.de/git/<owner>/<repo>.git.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@github.com>2019-12-05 15:43:03 +1100
committereric sciple <ericsciple@users.noreply.github.com>2019-12-04 23:43:03 -0500
commitb98d5dfcfd51b40cccb442d2d75d1dce8f845c13 (patch)
tree1ba105731589061f44ca57f06247b027b31ffcab
parent9cd5836e75e1d4e738850839f9556d7976e83cbe (diff)
Update description (#65)
-rw-r--r--README.md5
-rw-r--r--action.yml9
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