checkout/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](https://help.github.com/en/articles/events-that-trigger-workflows) to learn what `$GITHUB_SHA` is for different kinds of events.

# Usage

See [action.yml](action.yml)

Basic:
```yaml
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](LICENSE)
Add docs (#2) * Update README.md * Create LICENSE * Update README.md 2019-07-24 03:32:03 +08:00			`# checkout`

			`This action checks out your repository so that your workflow operates from the root of the repository`

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 22:53:03 +08: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.
README: Environment variable typo fix (#11) 2019-08-16 22:56:22 +08:00			See [here](https://help.github.com/en/articles/events-that-trigger-workflows) to learn what `$GITHUB_SHA` is for different kinds of events.
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 22:53:03 +08:00
Add docs (#2) * Update README.md * Create LICENSE * Update README.md 2019-07-24 03:32:03 +08:00			`# Usage`

			`See [action.yml](action.yml)`

			`Basic:`
			```yaml
actions to steps 2019-07-26 09:30:48 +08:00			`steps:`
Add docs (#2) * Update README.md * Create LICENSE * Update README.md 2019-07-24 03:32:03 +08:00			`- 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](LICENSE)`