Это действие проверяет ваш репозиторий под $GITHUB_WORKSPACE
, поэтому ваш рабочий процесс может получить к нему доступ.
Только один коммит получен по умолчанию, для Ref/SHA, который вызвал рабочий процесс. Установите fetch-depth: 0
чтобы получить всю историю для всех ветвей и тегов. Обратитесь здесь к изучению, на которые фиксирует $GITHUB_SHA
для различных событий.
Токен аудитория сохраняется в локальной конфигурации GIT. Это позволяет вашим сценариям запускать аутентифицированные команды GIT. Токен удаляется во время очистки после работы. Установка persist-credentials: false
отказаться.
Когда GIT 2.18 или выше не находится на вашем пути, возвращается к API REST для загрузки файлов.
Пожалуйста, обратитесь к странице релиза для последних заметок о выпуске.
- uses : actions/checkout@v4
with :
# 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: true
ssh-strict : ' '
# The user to use when connecting to the remote SSH host. By default 'git' is
# used.
# Default: git
ssh-user : ' '
# Whether to configure the token or SSH key with the local git config
# Default: true
persist-credentials : ' '
# Relative path under $GITHUB_WORKSPACE to place the repository
path : ' '
# Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching
# Default: true
clean : ' '
# Partially clone against a given filter. Overrides sparse-checkout if set.
# Default: null
filter : ' '
# Do a sparse checkout on given patterns. Each pattern should be separated with
# new lines.
# Default: null
sparse-checkout : ' '
# Specifies whether to use cone-mode when doing a sparse checkout.
# Default: true
sparse-checkout-cone-mode : ' '
# Number of commits to fetch. 0 indicates all history for all branches and tags.
# Default: 1
fetch-depth : ' '
# Whether to fetch tags, even if fetch-depth > 0.
# Default: false
fetch-tags : ' '
# Whether to show progress status output when fetching.
# Default: true
show-progress : ' '
# Whether to download Git-LFS files
# Default: false
lfs : ' '
# 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.
#
# Default: false
submodules : ' '
# Add repository path as safe.directory for Git global config by running `git
# config --global --add safe.directory <path>`
# Default: true
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
и src
папка- uses : actions/checkout@v4
with :
sparse-checkout : .
.github
и src
папка - uses : actions/checkout@v4
with :
sparse-checkout : |
.github
src
- uses : actions/checkout@v4
with :
sparse-checkout : |
README.md
sparse-checkout-cone-mode : false
- uses : actions/checkout@v4
with :
fetch-depth : 0
- uses : actions/checkout@v4
with :
ref : my-branch
- uses : actions/checkout@v4
with :
fetch-depth : 2
- run : git checkout HEAD^
- name : Checkout
uses : actions/checkout@v4
with :
path : main
- name : Checkout tools repo
uses : actions/checkout@v4
with :
repository : my-org/my-tools
path : my-tools
- Если ваш вторичный репозиторий является частным или внутренним, вам нужно будет добавить опцию, отмеченную в оформлении нескольких репо (частные)
- name : Checkout
uses : actions/checkout@v4
- name : Checkout tools repo
uses : actions/checkout@v4
with :
repository : my-org/my-tools
path : my-tools
- Если ваш вторичный репозиторий является частным или внутренним, вам нужно будет добавить опцию, отмеченную в оформлении нескольких репо (частные)
- name : Checkout
uses : actions/checkout@v4
with :
path : main
- 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
path : my-tools
${{ github.token }}
подходит к текущему репозиторию, поэтому, если вы хотите проверить другой репозиторий, который является частным, вам нужно будет предоставить свой собственный PAT.
- uses : actions/checkout@v4
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@v4
on : push
jobs :
build :
runs-on : ubuntu-latest
steps :
- 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 push
Примечание. Пользовательская электронная почта {user.id}+{user.login}@users.noreply.github.com
. См. Пользователи API: https://api.github.com/users/github-actions%5bbot%5d
В триггере запроса на вытягивание требуется ref
, поскольку действия GitHub проверяют в режиме отдельного головки, что означает, что он не проверяет вашу филиал по умолчанию.
on : pull_request
jobs :
build :
runs-on : ubuntu-latest
steps :
- uses : actions/checkout@v4
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
Примечание. Пользовательская электронная почта {user.id}+{user.login}@users.noreply.github.com
. См. Пользователи API: https://api.github.com/users/github-actions%5bbot%5d
Сценарии и документация в этом проекте выпускаются по лицензии MIT