Skip to content

Commit 0c2454c

Browse files
committed
Update documentation re: when github-token input is needed
Previously, there were multiple features that resulted in the requirement for providing a GitHub access token, but since the size trends report functionality was moved to a separate action there is only one feature that requires the use of the `github-token` input.
1 parent aa645f1 commit 0c2454c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Path in which to save a JSON formatted file containing data from the sketch comp
116116

117117
### `github-token`
118118

119-
GitHub access token used to get information from the GitHub API. Only needed if you're using the size report features with private repositories. It will be convenient to use [`${{ secrets.GITHUB_TOKEN }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token). Default `""`.
119+
GitHub access token used to get information from the GitHub API. Only needed for private repositories with `enable-size-deltas-report` set to `true`. It will be convenient to use [`${{ secrets.GITHUB_TOKEN }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token). Default `""`.
120120

121121
### `enable-size-deltas-report`
122122

0 commit comments

Comments
 (0)