diff options
| author | eric sciple <ericsciple@users.noreply.github.com> | 2020-03-12 00:59:09 -0400 |
|---|---|---|
| committer | eric sciple <ericsciple@users.noreply.github.com> | 2020-03-12 00:59:09 -0400 |
| commit | 706ad1e0e3f826823967b7165d7a2bc84e698cf5 (patch) | |
| tree | 37db3619fc82908d8b8fc2c1846c171c1c58e2a2 | |
| parent | 102e8f7bbdbd4f0df12cee6ac817816a8240ab97 (diff) | |
update verbiage; add comments
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | __test__/git-auth-helper.test.ts | 2 | ||||
| -rw-r--r-- | action.yml | 6 |
3 files changed, 10 insertions, 8 deletions
@@ -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 # 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. + # We recommend using 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: '' - # SSH key used to fetch the repository. SSH key is configured with the local git - # config, which enables your scripts to run authenticated git commands. The + # 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. # - # 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) ssh-key: '' diff --git a/__test__/git-auth-helper.test.ts b/__test__/git-auth-helper.test.ts index 67e1301..1d5c3d5 100644 --- a/__test__/git-auth-helper.test.ts +++ b/__test__/git-auth-helper.test.ts @@ -320,6 +320,8 @@ describe('git-auth-helper tests', () => { ).toString() expect(actualSshKeyContent).toBe(settings.sshKey + '\n') 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( 0o600 ) @@ -16,7 +16,7 @@ inputs: 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.
@@ -24,12 +24,12 @@ inputs: default: ${{ github.token }}
ssh-key:
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.
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
|
