Updated README to reflect GitHub limitations (#205)

* Updated README to reflect GitHub limitations

As GH comments cannot be over a certain size, providing a notice with an alternative.
This commit is contained in:
Renaud 2022-09-16 18:03:51 +02:00 committed by GitHub
parent 1f367ab8a7
commit 174039b7cd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -77,6 +77,12 @@ steps:
Outputs can be used in subsequent steps to comment on the pull request:
> **Notice:** There's a limit to the number of characters inside a GitHub comment (65535).
>
> Due to that limitation, you might end up with a failed workflow run even if the plan succeeded.
>
> Another approach is to append your plan into the $GITHUB_JOB_SUMMARY environment variable which supports markdown.
```yaml
defaults:
run: