actions/checkout
2
0
Fork 0
mirror of https://github.com/RouxAntoine/checkout.git synced 2024-12-29 05:57:21 +00:00
Code Packages Releases Activity
f6ce2afa70
checkout/README.md
Zeke Sikelianos 0963d3b35f add docs about checking out the triggering ref (#21) 
* add docs about checking out the triggering ref

* clarify checkout behavior
2019-09-05 11:42:49 -04:00

1.1 KiB
Raw Blame History

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

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:

- uses: actions/checkout@master
  with:
    ref: some-branch

For more details, see Contexts and expression syntax for GitHub Actions

License

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