From fc48dae304faeb68b17acd2f0451ef28ab16f066 Mon Sep 17 00:00:00 2001 From: Renaud Date: Fri, 20 May 2022 12:50:43 +0200 Subject: [PATCH] Updated README to reflect GitHub limitations As GH comments cannot be over a certain size, providing a notice with an alternative. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 79f3305..366badb 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,10 @@ 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: