Checkout v6

What's new

• Improved credential security:
  persist-credentials
  now stores credentials in a separate file under
  $RUNNER_TEMP
  instead of directly in
  .git/config
• No workflow changes required —
  git fetch
  ,
  git push
  , etc. continue to work automatically
• Running authenticated git commands from a Docker container action requires Actions Runner v2.329.0 or later

Checkout v5

What's new

• Updated to the node24 runtime
  • This requires a minimum Actions Runner version of v2.327.1 to run.

Checkout v4

This action checks-out your repository under

, so your workflow can access it.

Only a single commit is fetched by default, for the ref/SHA that triggered the workflow. Set

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

to opt-out.

When Git 2.18 or higher is not in your PATH, falls back to the REST API to download the files.

Note

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:

1. We will be directing questions and support requests to our Community Discussions area

2. 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.

3. 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.

What's new

Please refer to the release page for the latest release notes.

Usage

Scenarios

• Checkout V5
  • What's new
• Checkout V4
  • Note
• What's new
• Usage
• Scenarios
  • Fetch only the root files
  • Fetch only the root files and
    .github
    and
    src
    folder
  • 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
  • Push a commit to a PR using the built-in token
• Recommended permissions
• License

Fetch only the root files

Fetch only the root files and

.github

and

src

folder

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)

• If your secondary repository is private or internal you will need to add the option noted in Checkout multiple repos (private)

Checkout multiple repos (nested)

• If your secondary repository is private or internal you will need to add the option noted in Checkout multiple repos (private)

Checkout multiple repos (private)

• ${{ 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.

Checkout pull request HEAD commit instead of merge commit

Checkout pull request on closed event

Push a commit using the built-in token

NOTE: The user email is

. See users API: https://api.github.com/users/github-actions%5Bbot%5D

Push a commit to a PR using the built-in token

In a pull request trigger,

is required as GitHub Actions checks out in detached HEAD mode, meaning it doesn’t check out your branch by default.

NOTE: The user email is

. See users API: https://api.github.com/users/github-actions%5Bbot%5D

Recommended permissions

When using the

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:

License

The scripts and documentation in this project are released under the MIT License