Go to file

Max Held a14471d838 clarify language on working directory (#9 ) * clarify language I guess this action doesn't technically make sure that my working directory is `$GITHUB_WORKSPACE`, so this might be more precise? * fix repetition		2019-08-21 21:39:05 -04:00
action.yml	Update action.yml (#3 )	2019-08-16 11:00:30 -04:00
LICENSE	Add docs (#2 )	2019-07-23 15:32:03 -04:00
README.md	clarify language on working directory (#9 )	2019-08-21 21:39:05 -04:00

README.md

checkout

This action checks out your repository to $GITHUB_WORKSPACE, so that your workflow can access the contents of your 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 to learn what $GITHUB_SHA is for different kinds of events.

Usage

See action.yml

Basic:

steps:
- uses: actions/checkout@master
- uses: actions/setup-node@master
  with:
    node-version: 10.x 
- run: npm install
- run: npm test

License

The scripts and documentation in this project are released under the MIT License