Skip to content

Commit 6251c86

Browse files
Add detailed options for actions/checkout@v6
Detailed information from our latest report.
1 parent 5b8a8c9 commit 6251c86

File tree

1 file changed

+108
-0
lines changed

1 file changed

+108
-0
lines changed

content/actions/how-tos/create-and-publish-actions/publish-in-github-marketplace.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,3 +83,111 @@ Actions published on {% data variables.product.prodname_marketplace %} are linke
8383
Actions with the {% octicon "verified" aria-label="The verified badge" %}, or verified creator badge, indicate that {% data variables.product.prodname_dotcom %} has verified the creator of the action as a partner organization. Partners can email <a href="mailto:partnerships@github.com">partnerships@github.com</a> to request the verified creator badge.
8484

8585
![Screenshot of {% data variables.product.prodname_actions %} with the verified creator badge.](/assets/images/marketplace/verified-creator-badge-for-actions.png)
86+
- uses: actions/checkout@v6
87+
with:
88+
# Repository name with owner. For example, actions/checkout
89+
# Default: ${{ github.repository }}
90+
repository: ''
91+
92+
# The branch, tag or SHA to checkout. When checking out the repository that
93+
# triggered a workflow, this defaults to the reference or SHA for that event.
94+
# Otherwise, uses the default branch.
95+
ref: ''
96+
97+
# Personal access token (PAT) used to fetch the repository. The PAT is configured
98+
# with the local git config, which enables your scripts to run authenticated git
99+
# commands. The post-job step removes the PAT.
100+
#
101+
# We recommend using a service account with the least permissions necessary. Also
102+
# when generating a new PAT, select the least scopes necessary.
103+
#
104+
# [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)
105+
#
106+
# Default: ${{ github.token }}
107+
token: ''
108+
109+
# SSH key used to fetch the repository. The SSH key is configured with the local
110+
# git config, which enables your scripts to run authenticated git commands. The
111+
# post-job step removes the SSH key.
112+
#
113+
# We recommend using a service account with the least permissions necessary.
114+
#
115+
# [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)
116+
ssh-key: ''
117+
118+
# Known hosts in addition to the user and global host key database. The public SSH
119+
# keys for a host may be obtained using the utility `ssh-keyscan`. For example,
120+
# `ssh-keyscan github.com`. The public key for github.com is always implicitly
121+
# added.
122+
ssh-known-hosts: ''
123+
124+
# Whether to perform strict host key checking. When true, adds the options
125+
# `StrictHostKeyChecking=yes` and `CheckHostIP=no` to the SSH command line. Use
126+
# the input `ssh-known-hosts` to configure additional hosts.
127+
# Default: true
128+
ssh-strict: ''
129+
130+
# The user to use when connecting to the remote SSH host. By default 'git' is
131+
# used.
132+
# Default: git
133+
ssh-user: ''
134+
135+
# Whether to configure the token or SSH key with the local git config
136+
# Default: true
137+
persist-credentials: ''
138+
139+
# Relative path under $GITHUB_WORKSPACE to place the repository
140+
path: ''
141+
142+
# Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching
143+
# Default: true
144+
clean: ''
145+
146+
# Partially clone against a given filter. Overrides sparse-checkout if set.
147+
# Default: null
148+
filter: ''
149+
150+
# Do a sparse checkout on given patterns. Each pattern should be separated with
151+
# new lines.
152+
# Default: null
153+
sparse-checkout: ''
154+
155+
# Specifies whether to use cone-mode when doing a sparse checkout.
156+
# Default: true
157+
sparse-checkout-cone-mode: ''
158+
159+
# Number of commits to fetch. 0 indicates all history for all branches and tags.
160+
# Default: 1
161+
fetch-depth: ''
162+
163+
# Whether to fetch tags, even if fetch-depth > 0.
164+
# Default: false
165+
fetch-tags: ''
166+
167+
# Whether to show progress status output when fetching.
168+
# Default: true
169+
show-progress: ''
170+
171+
# Whether to download Git-LFS files
172+
# Default: false
173+
lfs: ''
174+
175+
# Whether to checkout submodules: `true` to checkout submodules or `recursive` to
176+
# recursively checkout submodules.
177+
#
178+
# When the `ssh-key` input is not provided, SSH URLs beginning with
179+
# `git@github.com:` are converted to HTTPS.
180+
#
181+
# Default: false
182+
submodules: ''
183+
184+
# Add repository path as safe.directory for Git global config by running `git
185+
# config --global --add safe.directory <path>`
186+
# Default: true
187+
set-safe-directory: ''
188+
189+
# The base URL for the GitHub instance that you are trying to clone from, will use
190+
# environment defaults to fetch from the same instance that the workflow is
191+
# running from unless specified. Example URLs are https://github.com or
192+
# https://my-ghes-server.example.com
193+
github-server-url: ''

0 commit comments

Comments
 (0)