Skip to content

Commit 8ada47d

Browse files
authored
update readme/changelog for v6 (actions#2311)
0 parents  commit 8ada47d

2 files changed

Lines changed: 148 additions & 0 deletions

File tree

action.yml

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
name: Checkout
2+
description: Checkout a Git repository at a particular version
3+
inputs:
4+
repository:
5+
description: Repository name with owner. For example, actions/checkout
6+
default: "${{ github.repository }}"
7+
ref:
8+
description: |
9+
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.
10+
token:
11+
description: |
12+
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.
13+
14+
We recommend using a service account with the least permissions necessary. Also when generating a new PAT, select the least scopes necessary.
15+
16+
[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)
17+
default: "${{ github.token }}"
18+
ssh-key:
19+
description: |
20+
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.
21+
22+
We recommend using a service account with the least permissions necessary.
23+
24+
[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)
25+
ssh-known-hosts:
26+
description: |
27+
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.
28+
ssh-strict:
29+
description: |
30+
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.
31+
default: true
32+
ssh-user:
33+
description: |
34+
The user to use when connecting to the remote SSH host. By default 'git' is used.
35+
default: git
36+
persist-credentials:
37+
description: Whether to configure the token or SSH key with the local git config
38+
default: true
39+
path:
40+
description: Relative path under $GITHUB_WORKSPACE to place the repository
41+
clean:
42+
description: "Whether to execute `git clean -ffdx && git reset --hard HEAD` before fetching"
43+
default: true
44+
filter:
45+
description: |
46+
Partially clone against a given filter. Overrides sparse-checkout if set.
47+
default: null
48+
sparse-checkout:
49+
description: |
50+
Do a sparse checkout on given patterns. Each pattern should be separated with new lines.
51+
default: null
52+
sparse-checkout-cone-mode:
53+
description: |
54+
Specifies whether to use cone-mode when doing a sparse checkout.
55+
default: true
56+
fetch-depth:
57+
description: Number of commits to fetch. 0 indicates all history for all branches and tags.
58+
default: 1
59+
fetch-tags:
60+
description: "Whether to fetch tags, even if fetch-depth > 0."
61+
default: false
62+
show-progress:
63+
description: Whether to show progress status output when fetching.
64+
default: true
65+
lfs:
66+
description: Whether to download Git-LFS files
67+
default: false
68+
submodules:
69+
description: |
70+
Whether to checkout submodules: `true` to checkout submodules or `recursive` to recursively checkout submodules.
71+
72+
When the `ssh-key` input is not provided, SSH URLs beginning with `git@github.com:` are converted to HTTPS.
73+
default: false
74+
set-safe-directory:
75+
description: "Add repository path as safe.directory for Git global config by running `git config --global --add safe.directory <path>`"
76+
default: true
77+
github-server-url:
78+
description: "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"
79+
required: false
80+
runs:
81+
using: composite
82+
steps:
83+
- uses: "bjoernboettle/checkout@900f2210b1d28bbbd0bd22d17926b9e224e8f231"
84+
with:
85+
repository: "${{ inputs.repository }}"
86+
ref: "${{ inputs.ref }}"
87+
token: "${{ inputs.token }}"
88+
ssh-key: "${{ inputs.ssh-key }}"
89+
ssh-known-hosts: "${{ inputs.ssh-known-hosts }}"
90+
ssh-strict: "${{ inputs.ssh-strict }}"
91+
ssh-user: "${{ inputs.ssh-user }}"
92+
persist-credentials: "${{ inputs.persist-credentials }}"
93+
path: "${{ inputs.path }}"
94+
clean: "${{ inputs.clean }}"
95+
filter: "${{ inputs.filter }}"
96+
sparse-checkout: "${{ inputs.sparse-checkout }}"
97+
sparse-checkout-cone-mode: "${{ inputs.sparse-checkout-cone-mode }}"
98+
fetch-depth: "${{ inputs.fetch-depth }}"
99+
fetch-tags: "${{ inputs.fetch-tags }}"
100+
show-progress: "${{ inputs.show-progress }}"
101+
lfs: "${{ inputs.lfs }}"
102+
submodules: "${{ inputs.submodules }}"
103+
set-safe-directory: "${{ inputs.set-safe-directory }}"
104+
github-server-url: "${{ inputs.github-server-url }}"
105+
- uses: "oven-sh/setup-bun@0c5077e51419868618aeaa5fe8019c62421857d6"
106+
- name: Cleanup Action
107+
shell: bash
108+
run: bun run $GITHUB_ACTION_PATH/index.js

index.js

Lines changed: 40 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)