-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add ssh support #163
add ssh support #163
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -45,14 +45,40 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous | |
# Otherwise, defaults to `master`. | ||
ref: '' | ||
|
||
# Auth token used to fetch the repository. The token is stored in the local git | ||
# config, which enables your scripts to run authenticated git commands. The | ||
# post-job step removes the token from the git config. [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) | ||
# 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 creating 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: '' | ||
|
||
# Whether to persist the token in the git config | ||
# SSH key used to fetch the repository. SSH key is configured with the local git | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. will fix in next pr |
||
# config, which enables your scripts to run authenticated git commands. The | ||
# post-job step removes the SSH key. | ||
# | ||
# We recommend creating a service account with the least permissions necessary. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: Same as above There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. will follow up on next pr |
||
# | ||
# [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: '' | ||
|
||
# Whether to configure the token or SSH key with the local git config | ||
# Default: true | ||
persist-credentials: '' | ||
|
||
|
@@ -73,6 +99,10 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous | |
|
||
# 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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🏅 |
||
# | ||
# Default: false | ||
submodules: '' | ||
``` | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
NIT: We recommend generating the PAT from a service account with only the necessary permissions.
may read a little better
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will follow up on next pr