Skip to content

Commit ae29594

Browse files
committed
feat: disclaimer
1 parent 603fa16 commit ae29594

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -158,18 +158,16 @@ jobs:
158158
Restrictions on Forks
159159
---------------------
160160
161-
Github Actions imposes higher Restrictions on workflows triggered from forks in public repositories, where the
162-
default token generated will have only read permissions.
161+
Github Actions [imposes higher Restrictions on workflows triggered from forks in public repositories][fork],
162+
where the default token generated will have only read permissions.
163163
164164
Because of that when this Action is run on pull requests from forks no comment will be created with the
165-
coverage report, instead only the summary will be created on the running workflow
166-
167-
This Action can't provide all the features when using forks to public repositories, this happens because
168-
Github limits the permissions on the auto-generated token used to add/update comments to the pull request.
169-
This is not a limitation for private repositories or pull requests that the head branch is in the same
170-
repository.
165+
coverage report, instead the report will only be shown at the steps summary.
171166
167+
![example of step summary with the report](./assets/summary-example.png)
172168
169+
If comments on pull request from forks are required for your workflow a [PAT](pat) can be used, but be aware
170+
that doing that may open the owner of the PAT to the malicious intentions of the internet.
173171
174172
[CHANGELOG](CHANGELOG.md)
175173
---------
@@ -178,3 +176,4 @@ repository.
178176
[pat]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
179177
[lang]: https://developer.mozilla.org/pt-BR/docs/Web/JavaScript/Reference/Global_Objects/Intl#argumento_locales
180178
[default-token]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication
179+
[fork]: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token

0 commit comments

Comments
 (0)