Compare commits

..

1 Commits

Author SHA1 Message Date
3204e0bf8c Update action.yml
This partially fixes #940 by updating the description to match the request. However I'm assuming the runner adds in the `Action` part by truncating the description? cc @bryanmacfarlane
2019-07-26 06:32:33 -07:00
2 changed files with 4 additions and 19 deletions

View File

@ -1,36 +1,22 @@
# checkout # checkout
This action checks out your repository to `$GITHUB_WORKSPACE`, so that your workflow can access the contents of your repository. This action checks out your repository so that your workflow operates from the root of the repository
By default, this is equivalent to running `git fetch` and `git checkout $GITHUB_SHA`, so that you'll always have your repo contents at the version that triggered the workflow.
See [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn what `$GITHUB_SHA` is for different kinds of events.
# Usage # Usage
See [action.yml](action.yml) See [action.yml](action.yml)
Basic: Basic:
```yaml ```yaml
steps: steps:
- uses: actions/checkout@master - uses: actions/checkout@master
- uses: actions/setup-node@master - uses: actions/setup-node@master
with: with:
node-version: 10.x version: 10.x
- run: npm install - run: npm install
- run: npm test - run: npm test
``` ```
By default, the branch or tag ref that triggered the workflow will be checked out. If you wish to check out a different branch, specify that using `with.ref`:
```yaml
- uses: actions/checkout@master
with:
ref: some-branch
```
For more details, see [Contexts and expression syntax for GitHub Actions](https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions)
# License # License
The scripts and documentation in this project are released under the [MIT License](LICENSE) The scripts and documentation in this project are released under the [MIT License](LICENSE)

View File

@ -1,5 +1,5 @@
name: 'Checkout' name: 'Checkout'
description: 'Checkout a Git repository.' description: 'Checkout a Git repository'
inputs: inputs:
repository: repository:
description: 'Repository name' description: 'Repository name'
@ -11,7 +11,7 @@ inputs:
description: 'If true, execute `execute git clean -ffdx && git reset --hard HEAD` before fetching' description: 'If true, execute `execute git clean -ffdx && git reset --hard HEAD` before fetching'
default: true default: true
submodules: submodules:
description: 'Whether to include submodules: false to exclude submodules, true to include only one level of submodules, or recursive to recursively clone submodules; defaults to false' description: 'Directory containing files to upload'
lfs: lfs:
description: 'Whether to download Git-LFS files; defaults to false' description: 'Whether to download Git-LFS files; defaults to false'
fetch-depth: fetch-depth:
@ -19,5 +19,4 @@ inputs:
path: path:
description: 'Optional path to check out source code' description: 'Optional path to check out source code'
runs: runs:
# Plugins live on the runner and are only available to a certain set of first party actions.
plugin: 'checkout' plugin: 'checkout'