Skip to content

Commit d66109d

Browse files
authored
Docs - Use GITHUB_TOKEN instead of personal access token (#11)
* Change github token in the docs * Remove the mention of the user
1 parent 7dc0e1a commit d66109d

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

packages/foo-api-docs/docs/lighthouse-check-github-action/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ Used in Slack notifications. In a [GitHub context](https://docs.github.com/en/ac
7676
### `gitHubAccessToken`
7777
**Type**: `string | undefined`
7878

79-
[Access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) of a user to post PR comments.
79+
[GitHub Action Token](https://docs.github.com/en/actions/security-guides/automatic-token-authentication) which allows to post PR comments.
8080

8181
### `locale`
8282
**Type**: `string | undefined`

packages/foo-api-docs/docs/lighthouse-check-github-action/examples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ In the below example we do the following:
6060
- Run Lighthouse on 2 URLs
6161
- Upload reports to AWS S3.
6262
- Notify via Slack with details about the change from Git data.
63-
- By specifying the `pull_request` trigger and `gitHubAccessToken` - we allow automatic comments of audits on the corresponding PR from the token user.
63+
- By specifying the `pull_request` trigger and `gitHubAccessToken` - we allow automatic comments of audits on the corresponding PR.
6464

6565
```yaml
6666
name: Test Lighthouse Check
@@ -81,7 +81,7 @@ jobs:
8181
awsSecretAccessKey: ${{ secrets.LIGHTHOUSE_CHECK_AWS_SECRET_ACCESS_KEY }}
8282
gitAuthor: ${{ github.actor }}
8383
gitBranch: ${{ github.ref }}
84-
gitHubAccessToken: ${{ secrets.LIGHTHOUSE_CHECK_GITHUB_ACCESS_TOKEN }}
84+
gitHubAccessToken: ${{ secrets.GITHUB_TOKEN }}
8585
outputDirectory: ${{ github.workspace }}/tmp/artifacts
8686
urls: 'https://www.foo.software,https://www.foo.software/contact'
8787
sha: ${{ github.sha }}

0 commit comments

Comments
 (0)