actions/checkout
3
0
Fork 0
mirror of https://code.forgejo.org/actions/checkout.git synced 2026-05-28 15:06:30 +00:00
Code Activity

Merge 7358b1bbf5 into 900f2210b1

Browse source
This commit is contained in:
Kranthi Poturaju 2026-05-25 19:14:11 +05:30 • committed by GitHub
commit d74e01fb97
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 21 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

28
action.yml
View file

@ -9,6 +9,7 @@ inputs:
The branch, tag or SHA to checkout. When checking out the repository that 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 triggered a workflow, this defaults to the reference or SHA for that
event. Otherwise, uses the default branch. event. Otherwise, uses the default branch.
required: false
token: token:
description: > description: >
Personal access token (PAT) used to fetch the repository. The PAT is configured Personal access token (PAT) used to fetch the repository. The PAT is configured
@ -34,11 +35,13 @@ inputs:
[Learn more about creating and using [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) encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
required: false
ssh-known-hosts: ssh-known-hosts:
description: > description: >
Known hosts in addition to the user and global host key database. The public 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 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-keyscan github.com`. The public key for github.com is always implicitly added.
required: false
ssh-strict: ssh-strict:
description: > description: >
Whether to perform strict host key checking. When true, adds the options `StrictHostKeyChecking=yes` Whether to perform strict host key checking. When true, adds the options `StrictHostKeyChecking=yes`
@ -50,23 +53,30 @@ inputs:
The user to use when connecting to the remote SSH host. By default 'git' is used. The user to use when connecting to the remote SSH host. By default 'git' is used.
default: git default: git
persist-credentials: persist-credentials:
description: 'Whether to configure the token or SSH key with the local git config' description: >
Whether to persist the token or SSH key credentials for use by subsequent
steps. When true, credentials are stored in a file under `$RUNNER_TEMP`
and referenced from the local git config. The post-job step removes the
credential file.
default: true default: true
path: path:
description: 'Relative path under $GITHUB_WORKSPACE to place the repository' description: 'Relative path under $GITHUB_WORKSPACE to place the repository'
default: '.'
required: false
clean: clean:
description: 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching' description: 'Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching'
default: true default: true
filter: filter:
description: > description: >
Partially clone against a given filter. Partially clone against a given filter. When `sparse-checkout` is also
Overrides sparse-checkout if set. set, overrides the default `blob:none` filter that would otherwise be
default: null used for fetching.
required: false
sparse-checkout: sparse-checkout:
description: > description: >
Do a sparse checkout on given patterns. Do a sparse checkout on given patterns.
Each pattern should be separated with new lines. Each pattern should be separated with new lines.
default: null required: false
sparse-checkout-cone-mode: sparse-checkout-cone-mode:
description: > description: >
Specifies whether to use cone-mode when doing a sparse checkout. Specifies whether to use cone-mode when doing a sparse checkout.
@ -100,9 +110,13 @@ inputs:
required: false required: false
outputs: outputs:
ref: ref:
description: 'The branch, tag or SHA that was checked out' description: >
The branch or tag ref that was checked out. Empty when the checkout was
performed by a full commit SHA.
commit: commit:
description: 'The commit SHA that was checked out' description: >
The commit SHA that was checked out. Only set when Git is available (not
set when the repository was downloaded via the GitHub REST API fallback).
runs: runs:
using: node24 using: node24
main: dist/index.js main: dist/index.js