mirror of
https://code.forgejo.org/actions/checkout.git
synced 2024-11-23 09:54:51 +01:00
update verbiage; add comments
This commit is contained in:
parent
518a867127
commit
2a15e11d5a
3 changed files with 10 additions and 8 deletions
10
README.md
10
README.md
|
@ -49,19 +49,19 @@ Refer [here](https://github.com/actions/checkout/blob/v1/README.md) for previous
|
||||||
# with the local git config, which enables your scripts to run authenticated git
|
# with the local git config, which enables your scripts to run authenticated git
|
||||||
# commands. The post-job step removes the PAT.
|
# commands. The post-job step removes the PAT.
|
||||||
#
|
#
|
||||||
# We recommend creating a service account with the least permissions necessary.
|
# We recommend using a service account with the least permissions necessary. Also
|
||||||
# Also when generating a new PAT, select the least scopes necessary.
|
# 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)
|
# [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 }}
|
# Default: ${{ github.token }}
|
||||||
token: ''
|
token: ''
|
||||||
|
|
||||||
# SSH key used to fetch the repository. SSH key is configured with the local git
|
# SSH key used to fetch the repository. The SSH key is configured with the local
|
||||||
# config, which enables your scripts to run authenticated git commands. The
|
# git config, which enables your scripts to run authenticated git commands. The
|
||||||
# post-job step removes the SSH key.
|
# post-job step removes the SSH key.
|
||||||
#
|
#
|
||||||
# We recommend creating a service account with the least permissions necessary.
|
# We recommend using a service account with the least permissions 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)
|
# [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: ''
|
ssh-key: ''
|
||||||
|
|
|
@ -320,6 +320,8 @@ describe('git-auth-helper tests', () => {
|
||||||
).toString()
|
).toString()
|
||||||
expect(actualSshKeyContent).toBe(settings.sshKey + '\n')
|
expect(actualSshKeyContent).toBe(settings.sshKey + '\n')
|
||||||
if (!isWindows) {
|
if (!isWindows) {
|
||||||
|
// Assert read/write for user, not group or others.
|
||||||
|
// Otherwise SSH client will error.
|
||||||
expect((await fs.promises.stat(actualSshKeyPath)).mode & 0o777).toBe(
|
expect((await fs.promises.stat(actualSshKeyPath)).mode & 0o777).toBe(
|
||||||
0o600
|
0o600
|
||||||
)
|
)
|
||||||
|
|
|
@ -16,7 +16,7 @@ inputs:
|
||||||
commands. The post-job step removes the PAT.
|
commands. The post-job step removes the PAT.
|
||||||
|
|
||||||
|
|
||||||
We recommend creating a service account with the least permissions necessary.
|
We recommend using a service account with the least permissions necessary.
|
||||||
Also when generating a new PAT, select the least scopes necessary.
|
Also when generating a new PAT, select the least scopes necessary.
|
||||||
|
|
||||||
|
|
||||||
|
@ -24,12 +24,12 @@ inputs:
|
||||||
default: ${{ github.token }}
|
default: ${{ github.token }}
|
||||||
ssh-key:
|
ssh-key:
|
||||||
description: >
|
description: >
|
||||||
SSH key used to fetch the repository. SSH key is configured with the local
|
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.
|
git config, which enables your scripts to run authenticated git commands.
|
||||||
The post-job step removes the SSH key.
|
The post-job step removes the SSH key.
|
||||||
|
|
||||||
|
|
||||||
We recommend creating a service account with the least permissions necessary.
|
We recommend using a service account with the least permissions necessary.
|
||||||
|
|
||||||
|
|
||||||
[Learn more about creating and using
|
[Learn more about creating and using
|
||||||
|
|
Loading…
Reference in a new issue