Checkout V2

What's new

Usage

- uses: actions/checkout@v2
 with:
 # Repository name with owner. For example, actions/checkout
 # Default: ${{ github.repository }}
 repository: ''
 # The branch, tag or SHA to checkout. When checking out the repository that
 # triggered a workflow, this defaults to the reference or SHA for that event.
 # Otherwise, defaults to `master`.
 ref: ''
 # Personal access token (PAT) used to fetch the repository. The PAT is configured
 # with the local git config, which enables your scripts to run authenticated git
 # commands. The post-job step removes the PAT.
 #
 # We recommend using a service account with the least permissions necessary. Also
 # when generating a new PAT, select the least scopes necessary.
 #
 # [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
 #
 # Default: ${{ github.token }}
 token: ''
 # SSH key used to fetch the repository. The SSH key is configured with the local
 # git config, which enables your scripts to run authenticated git commands. The
 # post-job step removes the SSH key.
 #
 # We recommend using a service account with the least permissions necessary.
 #
 # [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
 ssh-key: ''
 # Known hosts in addition to the user and global host key database. The public SSH
 # keys for a host may be obtained using the utility `ssh-keyscan`. For example,
 # `ssh-keyscan github.com`. The public key for github.com is always implicitly
 # added.
 ssh-known-hosts: ''
 # Whether to perform strict host key checking. When true, adds the options
 # `StrictHostKeyChecking=yes` and `CheckHostIP=no` to the SSH command line. Use
 # the input `ssh-known-hosts` to configure additional hosts.
 # Default: true
 ssh-strict: ''
 # Whether to configure the token or SSH key with the local git config
 # Default: true
 persist-credentials: ''
 # Relative path under $GITHUB_WORKSPACE to place the repository
 path: ''
 # Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching
 # Default: true
 clean: ''
 # Number of commits to fetch. 0 indicates all history.
 # Default: 1
 fetch-depth: ''
 # Whether to download Git-LFS files
 # Default: false
 lfs: ''
 # Whether to checkout submodules: `true` to checkout submodules or `recursive` to
 # recursively checkout submodules.
 #
 # When the `ssh-key` input is not provided, SSH URLs beginning with
 # `git@github.com:` are converted to HTTPS.
 #
 # Default: false
 submodules: ''

Scenarios

Fetch all history for all tags and branches

- uses: actions/checkout@v2
 with:
 fetch-depth: 0

Checkout a different branch

- uses: actions/checkout@v2
 with:
 ref: my-branch

Checkout HEAD^

- uses: actions/checkout@v2
 with:
 fetch-depth: 2
- run: git checkout HEAD^

Checkout multiple repos (side by side)

- name: Checkout
 uses: actions/checkout@v2
 with:
 path: main
- name: Checkout tools repo
 uses: actions/checkout@v2
 with:
 repository: my-org/my-tools
 path: my-tools

Checkout multiple repos (nested)

- name: Checkout
 uses: actions/checkout@v2
- name: Checkout tools repo
 uses: actions/checkout@v2
 with:
 repository: my-org/my-tools
 path: my-tools

Checkout multiple repos (private)

- name: Checkout
 uses: actions/checkout@v2
 with:
 path: main
- name: Checkout private tools
 uses: actions/checkout@v2
 with:
 repository: my-org/my-private-tools
 token: ${{ secrets.GitHub_PAT }} # `GitHub_PAT` is a secret that contains your PAT
 path: my-tools

Checkout pull request HEAD commit instead of merge commit

- uses: actions/checkout@v2
 with:
 ref: ${{ github.event.pull_request.head.sha }}

Checkout pull request on closed event

on:
 pull_request:
 branches: [master]
 types: [opened, synchronize, closed]
jobs:
 build:
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v2

License