Action for checking out a repo
Find a file
2019-11-04 14:40:15 -05:00
action.yml Revert "Upgrade checkout to v1.1.0 to better support scripting git. (#56)" 2019-11-04 14:40:15 -05:00
LICENSE Add docs (#2) 2019-07-23 15:32:03 -04:00
README.md Revert "Upgrade checkout to v1.1.0 to better support scripting git. (#56)" 2019-11-04 14:40:15 -05:00

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