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.
hashicorp · Sep 16, 2022 · 174039b · 174039b
1 parent 1f367ab
commit 174039b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -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: