actions/checkout@v7
Checkout a Git repository at a particular version
At a glance
- Latest major
v7- Repository
- actions/checkout
- Inputs
- 21 (0 required)
- Outputs
- 2
- Runs using
node24- License
- MIT
- Last checked
Inputs and outputs come straight from the action's official action.yml. See our editorial standards.
Usage
- uses: actions/checkout@v7Inputs
| Name | Required | Default | Description |
|---|---|---|---|
repository | No | ${{ github.repository }} | Repository name with owner. For example, actions/checkout |
ref | No | none | 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. |
token | No | ${{ github.token }} | 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) |
ssh-key | No | none | 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-known-hosts | No | none | 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-strict | No | true | 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. |
ssh-user | No | git | The user to use when connecting to the remote SSH host. By default 'git' is used. |
persist-credentials | No | true | Whether to configure the token or SSH key with the local git config |
path | No | none | Relative path under $GITHUB_WORKSPACE to place the repository |
clean | No | true | Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching |
filter | No | none | Partially clone against a given filter. Overrides sparse-checkout if set. |
sparse-checkout | No | none | Do a sparse checkout on given patterns. Each pattern should be separated with new lines. |
sparse-checkout-cone-mode | No | true | Specifies whether to use cone-mode when doing a sparse checkout. |
fetch-depth | No | 1 | Number of commits to fetch. 0 indicates all history for all branches and tags. |
fetch-tags | No | false | Whether to fetch tags, even if fetch-depth > 0. |
show-progress | No | true | Whether to show progress status output when fetching. |
lfs | No | false | Whether to download Git-LFS files |
submodules | No | false | 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 `[email protected]:` are converted to HTTPS. |
set-safe-directory | No | true | Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory <path>` |
github-server-url | No | none | 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.com |
allow-unsafe-pr-checkout | No | false | Required to check out fork pull request code from a workflow triggered by `pull_request_target` or `workflow_run`. These workflows run with the base repository's GITHUB_TOKEN, secrets, default-branch cache scope, and runner access; fetching and executing a fork's code in that trusted context commonly leads to "pwn request" vulnerabilities. Set to `true` only after reviewing the risks at https://gh.io/securely-using-pull_request_target. |
Outputs
| Name | Description |
|---|---|
ref | The branch, tag or SHA that was checked out |
commit | The commit SHA that was checked out |
Read an output with ${{ steps.<step-id>.outputs.<name> }}; the step needs an id.
Examples
Fetch the full history
Tag-based versioning, changelogs and `git describe` need every commit, not just the latest.
name: Example
on:
push:
branches: [main]
permissions:
contents: read
jobs:
example:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v7
with:
fetch-depth: 0
- run: git describe --tags --alwaysCheck out a second repository
Pull shared config or scripts from another repository into a subfolder.
name: Example
on:
push:
branches: [main]
permissions:
contents: read
jobs:
example:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v7
with:
repository: my-org/shared-config
path: shared-config
token: ${{ secrets.GITHUB_TOKEN }}Each example passed actionlint (syntax, expressions and the inputs it knows for this action). They were not run in a live repository, so replace placeholder values such as names, ARNs and paths with your own.
Something out of date or wrong? Report it on our Contact page. This page is rebuilt from the action's repository roughly once a week.