Skip to content

Commit b2e6b7e

Browse files
authored
add ssh support (#163)
1 parent 80602fa commit b2e6b7e

File tree

10 files changed

+837
-58
lines changed

10 files changed

+837
-58
lines changed

README.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,40 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
4545
# Otherwise, defaults to `master`.
4646
ref: ''
4747

48-
# Auth token used to fetch the repository. The token is stored in the local git
49-
# config, which enables your scripts to run authenticated git commands. The
50-
# post-job step removes the token from the git config. [Learn more about creating
51-
# and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
48+
# Personal access token (PAT) used to fetch the repository. The PAT is configured
49+
# with the local git config, which enables your scripts to run authenticated git
50+
# commands. The post-job step removes the PAT.
51+
#
52+
# We recommend creating a service account with the least permissions necessary.
53+
# Also when generating a new PAT, select the least scopes necessary.
54+
#
55+
# [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)
56+
#
5257
# Default: ${{ github.token }}
5358
token: ''
5459

55-
# Whether to persist the token in the git config
60+
# SSH key used to fetch the repository. SSH key is configured with the local git
61+
# config, which enables your scripts to run authenticated git commands. The
62+
# post-job step removes the SSH key.
63+
#
64+
# We recommend creating a service account with the least permissions necessary.
65+
#
66+
# [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)
67+
ssh-key: ''
68+
69+
# Known hosts in addition to the user and global host key database. The public SSH
70+
# keys for a host may be obtained using the utility `ssh-keyscan`. For example,
71+
# `ssh-keyscan github.com`. The public key for github.com is always implicitly
72+
# added.
73+
ssh-known-hosts: ''
74+
75+
# Whether to perform strict host key checking. When true, adds the options
76+
# `StrictHostKeyChecking=yes` and `CheckHostIP=no` to the SSH command line. Use
77+
# the input `ssh-known-hosts` to configure additional hosts.
78+
# Default: true
79+
ssh-strict: ''
80+
81+
# Whether to configure the token or SSH key with the local git config
5682
# Default: true
5783
persist-credentials: ''
5884

@@ -73,6 +99,10 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
7399

74100
# Whether to checkout submodules: `true` to checkout submodules or `recursive` to
75101
# recursively checkout submodules.
102+
#
103+
# When the `ssh-key` input is not provided, SSH URLs beginning with
104+
# `git@github.com:` are converted to HTTPS.
105+
#
76106
# Default: false
77107
submodules: ''
78108
```

0 commit comments

Comments
 (0)