This action checks-out your repository under $GITHUB_WORKSPACE, so your workflow can access it.
Only a single commit is fetched by default, for the ref/SHA that triggered the workflow. Set fetch-depth: 0 to fetch all history for all branches and tags. Refer here to learn which commit $GITHUB_SHA points to for different events.
The auth token is persisted in the local git config. This enables your scripts to run authenticated git commands. The token is removed during post-job cleanup. Set persist-credentials: false to opt-out.
When Git 2.18 or higher is not in your PATH, falls back to the REST API to download the files.
Please refer to the release page for the latest release notes.
- uses: actions/checkout@v4with:
# 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, uses the default branch.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: truessh-strict: ''# The user to use when connecting to the remote SSH host. By default 'git' is# used.# Default: gitssh-user: ''# Whether to configure the token or SSH key with the local git config# Default: truepersist-credentials: ''# Relative path under $GITHUB_WORKSPACE to place the repositorypath: ''# Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching# Default: trueclean: ''# Partially clone against a given filter. Overrides sparse-checkout if set.# Default: nullfilter: ''# Do a sparse checkout on given patterns. Each pattern should be separated with# new lines.# Default: nullsparse-checkout: ''# Specifies whether to use cone-mode when doing a sparse checkout.# Default: truesparse-checkout-cone-mode: ''# Number of commits to fetch. 0 indicates all history for all branches and tags.# Default: 1fetch-depth: ''# Whether to fetch tags, even if fetch-depth > 0.# Default: falsefetch-tags: ''# Whether to show progress status output when fetching.# Default: trueshow-progress: ''# Whether to download Git-LFS files# Default: falselfs: ''# 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: falsesubmodules: ''# Add repository path as safe.directory for Git global config by running `git# config --global --add safe.directory <path>`# Default: trueset-safe-directory: ''# The base URL for the GitHub instance that you are trying to clone from, will use# environment defaults to fetch from the same instance that the workflow is# running from unless specified. Example URLs are https://github.com or# https://my-ghes-server.example.comgithub-server-url: ''- Fetch only the root files
- Fetch only the root files and
.githubandsrcfolder - Fetch only a single file
- Fetch all history for all tags and branches
- Checkout a different branch
- Checkout HEAD^
- Checkout multiple repos (side by side)
- Checkout multiple repos (nested)
- Checkout multiple repos (private)
- Checkout pull request HEAD commit instead of merge commit
- Checkout pull request on closed event
- Push a commit using the built-in token
- uses: actions/checkout@v4with:
sparse-checkout: .- uses: actions/checkout@v4with:
sparse-checkout: | .github src- uses: actions/checkout@v4with:
sparse-checkout: | README.mdsparse-checkout-cone-mode: false- uses: actions/checkout@v4with:
fetch-depth: 0- uses: actions/checkout@v4with:
ref: my-branch- uses: actions/checkout@v4with:
fetch-depth: 2
- run: git checkout HEAD^- name: Checkoutuses: actions/checkout@v4with:
path: main
- name: Checkout tools repouses: actions/checkout@v4with:
repository: my-org/my-toolspath: my-tools
- If your secondary repository is private you will need to add the option noted in Checkout multiple repos (private)
- name: Checkoutuses: actions/checkout@v4
- name: Checkout tools repouses: actions/checkout@v4with:
repository: my-org/my-toolspath: my-tools
- If your secondary repository is private you will need to add the option noted in Checkout multiple repos (private)
- name: Checkoutuses: actions/checkout@v4with:
path: main
- name: Checkout private toolsuses: actions/checkout@v4with:
repository: my-org/my-private-toolstoken: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PATpath: my-tools
${{ github.token }}is scoped to the current repository, so if you want to checkout a different repository that is private you will need to provide your own PAT.
- uses: actions/checkout@v4with:
ref: ${{ github.event.pull_request.head.sha }}on:
pull_request:
branches: [main]types: [opened, synchronize, closed]jobs:
build:
runs-on: ubuntu-lateststeps:
- uses: actions/checkout@v4on: pushjobs:
build:
runs-on: ubuntu-lateststeps:
- uses: actions/checkout@v4
- run: | date > generated.txt # Note: the following account information will not work on GHES git config user.name "github-actions[bot]" git config user.email "41898282+github-actions[bot]@users.noreply.github.com" git add . git commit -m "generated" git pushThe scripts and documentation in this project are released under the MIT License