2019-07-23 19:32:03 +00:00
# checkout
2019-08-22 01:39:05 +00:00
This action checks out your repository to `$GITHUB_WORKSPACE` , so that your workflow can access the contents of your repository.
2019-07-23 19:32:03 +00:00
2019-08-13 14:53:03 +00:00
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.
2019-08-16 14:56:22 +00:00
See [here ](https://help.github.com/en/articles/events-that-trigger-workflows ) to learn what `$GITHUB_SHA` is for different kinds of events.
2019-08-13 14:53:03 +00:00
2019-07-23 19:32:03 +00:00
# Usage
See [action.yml ](action.yml )
Basic:
```yaml
2019-07-26 01:30:48 +00:00
steps:
2019-07-23 19:32:03 +00:00
- uses: actions/checkout@master
- uses: actions/setup-node@master
with:
2019-08-16 14:59:11 +00:00
node-version: 10.x
2019-07-23 19:32:03 +00:00
- run: npm install
- run: npm test
```
# License
The scripts and documentation in this project are released under the [MIT License ](LICENSE )
