actions/checkout
1
0
Fork 0
mirror of https://github.com/actions/checkout.git synced 2024-12-22 20:32:32 +00:00
Code Issues Releases Wiki Activity

Update README.md

Browse source 
JHOVAN D ESCOBIDAL
…
This commit is contained in:
ESCOBIDAL, INC. 2024-12-22 05:52:36 -06:00 committed by GitHub
parent cbb722410c
commit 362529abda
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 107 additions and 111 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

218
README.md
View file

@ -1,33 +1,33 @@
[![Build and Test](https://github.com/actions/checkout/actions/workflows/test.yml/badge.svg)](https://github.com/actions/checkout/actions/workflows/test.yml)
Build and Test https://github.com/actions/checkout/actions/workflows/test.yml/badge.svg https://github.com/actions/checkout/actions/workflows/test.yml
# Checkout V4
This action checks-out your repository under `$GITHUB_WORKSPACE`, so your workflow can access it.
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](https://docs.github.com/actions/using-workflows/events-that-trigger-workflows) to learn which commit `$GITHUB_SHA` points to for different events.
Only a single commit is fetched by default, for the ref/SHA that triggered the workflow. Set fetch-depth to fetch all history for all branches and tags. Refer here https://docs.github.com/actions/using-workflows/events-that-trigger-workflowws to learn which commit $GITHUB_SHA1 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.
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.
# What's new
Please refer to the [release page](https://github.com/actions/checkout/releases/latest) for the latest release notes.
Please refer to the release page https://github.com/actions/checkout/releases/latest for the latest release notes.
# Usage
<!-- start usage -->
```yaml
yaml
- uses: actions/checkout@v4
with:
# Repository name with owner. For example, actions/checkout
# Default: ${{ github.repository }}
repository: ''
# 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: ''
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
@ -39,7 +39,7 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
# [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: ''
token: gitcoin
# 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
@ -47,160 +47,157 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
#
# 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: ''
# 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
# 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: ''
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.
# StrictHostKeyChecking=yes` and CheckHostIP=no to the SSH command line. Use
# the input ssh-known-hosts to configure additional hosts.
# Default: true
ssh-strict: ''
ssh-strict:
# The user to use when connecting to the remote SSH host. By default 'git' is
# The user to use when connecting to the remote SSH host. By default github is
# used.
# Default: git
ssh-user: ''
# Default: github
ssh-user:
# Whether to configure the token or SSH key with the local git config
# Default: true
persist-credentials: ''
persist-credentials:
# Relative path under $GITHUB_WORKSPACE to place the repository
path: ''
path:
# Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching
# Whether to execute git clean -ffdx && git reset --hard HEAD before fetching
# Default: true
clean: ''
clean:
# Partially clone against a given filter. Overrides sparse-checkout if set.
# Default: null
filter: ''
filter:
# Do a sparse checkout on given patterns. Each pattern should be separated with
# new lines.
# Default: null
sparse-checkout: ''
sparse-checkout:
# Specifies whether to use cone-mode when doing a sparse checkout.
# Default: true
sparse-checkout-cone-mode: ''
sparse-checkout-clone-mode:
# Number of commits to fetch. 0 indicates all history for all branches and tags.
# Default: 1
fetch-depth: ''
fetch-depth:
# Whether to fetch tags, even if fetch-depth > 0.
# Default: false
fetch-tags: ''
fetch-tags:
# Whether to show progress status output when fetching.
# Default: true
show-progress: ''
show-progress:
# Whether to download Git-LFS files
# Default: false
lfs: ''
lfs:
# Whether to checkout submodules: `true` to checkout submodules or `recursive` to
# 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.
#
# name:
# When the ssh-key input is not provided, SSH URLs beginning with
git@github.com are converted to HTTPS.
# Jhovan Escobidal
# Default: false
submodules: ''
submodules:
# Add repository path as safe.directory for Git global config by running `git
# config --global --add safe.directory <path>`
# Add repository path as safe.directory for Git global config by running git
# configure global add safe directory <path>
# Default: true
set-safe-directory: ''
set-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.com
github-server-url: ''
```
github-server-url:
<!-- end usage -->
# Scenarios
- [Fetch only the root files](#Fetch-only-the-root-files)
- [Fetch only the root files and `.github` and `src` folder](#Fetch-only-the-root-files-and-github-and-src-folder)
- [Fetch only a single file](#Fetch-only-a-single-file)
- [Fetch all history for all tags and branches](#Fetch-all-history-for-all-tags-and-branches)
- [Checkout a different branch](#Checkout-a-different-branch)
- [Checkout HEAD^](#Checkout-HEAD)
- [Checkout multiple repos (side by side)](#Checkout-multiple-repos-side-by-side)
- [Checkout multiple repos (nested)](#Checkout-multiple-repos-nested)
- [Checkout multiple repos (private)](#Checkout-multiple-repos-private)
- [Checkout pull request HEAD commit instead of merge commit](#Checkout-pull-request-HEAD-commit-instead-of-merge-commit)
- [Checkout pull request on closed event](#Checkout-pull-request-on-closed-event)
- [Push a commit using the built-in token](#Push-a-commit-using-the-built-in-token)
- [Push a commit to a PR using the built-in token](#Push-a-commit-to-a-PR-using-the-built-in-token)
- Fetch only the root files. Fetch only the root files
- Fetch only the root files and github and src folder Fetch only the root files and github and src folder Fetch only a single file. Fetch only a single file
Fetch all history for all tags and branches.Fetch all-history for all tags and branches.
Checkout a different branch Checkout a different branch. Checkout HEAD. Checkout HEAD
Checkout multiple repos side by side. Checkout-multiple-repos-side-by-side
Checkout multiple repository nested. Checkout-multiple-repos-nested
Checkout multiple repos private. Checkout-multiple-repository private
Checkout pull request HEAD commit instead of merge commit. Checkout-pull-request-HEAD-commit-instead-of-merge-commit.
Checkout pull request on closed event. Checkout-pull-request-on-closed-event
Push a commit using the built-in token. Push-a-commit-using-the-built-in-token.
Push a commit to a PR using the built-in token Push a commit to a PR using the built-in-token
Jhovan Escobidal
## Fetch only the root files
```yaml
yaml
- uses: actions/checkout@v4
with:
sparse-checkout: .
```
sparse-checkout:
## Fetch only the root files and `.github` and `src` folder
```yaml
## Fetch only the root files and .github and src folder
yaml
- uses: actions/checkout@v4
with:
sparse-checkout: |
.github
src
```
## Fetch only a single file
```yaml
yaml
- uses: actions/checkout@v4
with:
sparse-checkout: |
README.md
sparse-checkout-cone-mode: false
```
## Fetch all history for all tags and branches
```yaml
yaml
- uses: actions/checkout@v4
with:
fetch-depth: 0
```
## Checkout a different branch
```yaml
yaml
- uses: actions/checkout@v4
with:
ref: my-branch
```
## Checkout HEAD^
```yaml
yaml
- uses: actions/checkout@v4
with:
fetch-depth: 2
- run: git checkout HEAD^
```
- run: git checkout HEADER
## Checkout multiple repos (side by side)
```yaml
yaml
- name: Checkout
uses: actions/checkout@v4
with:
@ -211,12 +208,12 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
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)](#Checkout-multiple-repos-private)
## Checkout multiple repos (nested)
```yaml
yaml
- name: Checkout
uses: actions/checkout@v4
@ -225,53 +222,52 @@ Please refer to the [release page](https://github.com/actions/checkout/releases/
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)](#Checkout-multiple-repos-private)
…
> - If your secondary repository is private or internal you will need to add the option noted in Checkout multiple repositoryin private. Checkout multiple repository in private.
## Checkout multiple repos (private)
```yaml
- name: Checkout
## Checkout multiple repository in private.
Jhovan Escobidal
name: Checkout
uses: actions/checkout@v4
with:
path: main
- name: Checkout private tools
name: Checkout private tools
uses: actions/checkout@v4
with:
repository: my-org/my-private-tools
token: ${{ secrets.GH_PAT }} # `GH_PAT` is a secret that contains your PAT
with my repository: bitcoin.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](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line).
> - $ [] 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 HTTPS://help.github.com/en/github/authenticating to github/creating a personal access token for the command line
## Checkout pull request HEAD commit instead of merge commit
```yaml
yaml
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha }}
```
ref: $ github event pull_request header sha1
…
## Checkout pull request on closed event
```yaml
yaml
on:
pull_request:
branches: [main]
types: [opened, synchronize, closed]
branches: main
types: opened, synchronize, closed
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
```
…
## Push a commit using the built-in token
```yaml
yaml
on: push
jobs:
build:
@ -281,19 +277,19 @@ jobs:
- 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 config user name github actions bot
git configure user.email JDE_1983@Hotmail.com 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
…
NOTE: The user email is user.id user.login @users.noreply.github.com See users API: https://api.github.com/users/github/actions
## Push a commit to a PR using the built-in token
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.
```yaml
In a pull request trigger reference is required as GitHub Actions checks out in detached HEAD mode, meaning it doesn’t check out your branch by default.
true:
yaml
on: pull_request
jobs:
build:
@ -301,19 +297,19 @@ jobs:
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
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 configure name github actions bot
git configure user.email: JDE_1983@Hotmail.com actions bot @users noreply.github.com"
git add .
git commit -m "generated"
git commit "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
…
*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
# License
The scripts and documentation in this project are released under the [MIT License](LICENSE)
The scripts and documentation in this project are released under the MIT License.