Go to file

Max Held b4b537b06a clarify default checkout sha (#10 ) this is trivial for `on: push`, but might be helpful to remind readers that this ain't always so for other events. Hence the link to the docs.		2019-08-13 10:53:03 -04:00
LICENSE	Add docs (#2 )	2019-07-23 15:32:03 -04:00
README.md	clarify default checkout sha (#10 )	2019-08-13 10:53:03 -04:00
action.yml	add checkout action.yml (#1 )	2019-07-23 11:50:59 -04:00

README.md

checkout

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 to learn what $GITHUBS_SHA is for different kinds of events.

Usage

See action.yml

Basic:

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

License

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