Action for checking out a repo
pull_request_target or workflow_run. These triggers run with the base repository's GITHUB_TOKEN, secrets, and runner access, where executing a fork's code commonly leads to "pwn request" vulnerabilities.allow-unsafe-pr-checkout: true input.actions/checkout to ESM to support new versions of the @actions/* packages.persist-credentials now stores credentials in a separate file under $RUNNER_TEMP instead of directly in .git/configgit fetch, git push, etc. continue to work automaticallyThis 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.
Thank you for your interest in this GitHub action, however, right now we are not taking contributions.
We continue to focus our resources on strategic areas that help our customers be successful while making developers' lives easier. While GitHub Actions remains a key part of this vision, we are allocating resources towards other areas of Actions and are not taking contributions to this repository at this time. The GitHub public roadmap is the best place to follow along for any updates on features we’re working on and what stage they’re in.
We are taking the following steps to better direct requests related to GitHub Actions, including:
We will be directing questions and support requests to our Community Discussions area
High Priority bugs can be reported through Community Discussions or you can report these to our support team https://support.github.com/contact/bug-report.
Security Issues should be handled as per our security.md
We will still provide security updates for this project and fix major breaking changes during this time.
You are welcome to still raise bugs in this repo.
Please refer to the release page for the latest release notes.
…
.github and src folder- uses: actions/checkout@v7
with:
sparse-checkout: .
.github and src folder- uses: actions/checkout@v7
with:
sparse-checkout: |
.github
src
- uses: actions/checkout@v7
with:
sparse-checkout: |
README.md
sparse-checkout-cone-mode: false
- uses: actions/checkout@v7
with:
fetch-depth: 0
- uses: actions/checkout@v7
with:
ref: my-branch
- uses: actions/checkout@v7
with:
fetch-depth: 2
- run: git checkout HEAD^
- name: Checkout
uses: actions/checkout@v7
with:
path: main
- name: Checkout tools repo
uses: actions/checkout@v7
with:
repository: my-org/my-tools
path: my-tools
- If your secondary repository is private or internal you will need to add the option noted in Checkout multiple repos (private)
- name: Checkout
uses: actions/checkout@v7
- name: Checkout tools repo
uses: actions/checkout@v7
with:
repository: my-org/my-tools
path: my-tools
- If your secondary repository is private or internal you will need to add the option noted in Checkout multiple repos (private)
- name: Checkout
uses: actions/checkout@v7
with:
path: main
- name: Checkout private tools
uses: actions/checkout@v7
with:
repository: my-org/my-private-tools
token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT
path: 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@v7
with:
ref: ${{ github.event.pull_request.head.sha }}
on:
pull_request:
branches: [main]
types: [opened, synchronize, closed]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
- 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 push
NOTE: The user email is {user.id}+{user.login}@users.noreply.github.com. See users API: https://api.github.com/users/github-actions%5Bbot%5D
In a pull request trigger, ref is required as GitHub Actions checks out in detached HEAD mode, meaning it doesn’t check out your branch by default.
on: pull_request
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v7
with:
ref: ${{ github.head_ref }}
- 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 push
NOTE: The user email is {user.id}+{user.login}@users.noreply.github.com. See users API: https://api.github.com/users/github-actions%5Bbot%5D
When using the checkout action in your GitHub Actions workflow, it is recommended to set the following GITHUB_TOKEN permissions to ensure proper functionality, unless alternative auth is provided via the token or ssh-key inputs:
permissions:
contents: read
The scripts and documentation in this project are released under the MIT License
No open issues yet, or sync has not completed.