From 174039b7cdb92c8286796e271a5abb48f5e1fc69 Mon Sep 17 00:00:00 2001
From: Renaud <github@rnsc.be>
Date: Fri, 16 Sep 2022 18:03:51 +0200
Subject: [PATCH] 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.
---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 662097fc..136dd54c 100644
--- 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: