Formatting is broken when comments are continued on GitHub

[timoguin]

When long Terraform plan output gets split into multiple comments on GitHub, the Markdown formatting is unrendered in the subsequent comments.

Here's a screenshot with some example output:

[timoguin]

It seems this is due to splitting the comment after the Markdown has been rendered. I'm guessing the second comment needs the triple backticks (```) that get stripped out.

Markdown rendering and comment creation are done here:

atlantis/server/events/command_handler.go

Lines 201 to 202 in 5d1722b

	comment := c.MarkdownRenderer.Render(res, ctx.Command.Name, ctx.Log.History.String(), ctx.Command.Verbose)
	c.VCSClient.CreateComment(ctx.BaseRepo, ctx.Pull.Num, comment) // nolint: errcheck

Splitting is done here:

atlantis/server/events/vcs/github_client.go

Lines 93 to 99 in 5d1722b

	comments := g.splitAtMaxChars(comment, maxCommentBodySize, "\ncontinued...\n")
	for _, c := range comments {
	_, _, err := g.client.Issues.CreateComment(g.ctx, repo.Owner, repo.Name, pullNum, &github.IssueComment{Body: &c})
	if err != nil {
	return err
	}
	}

[lkysow]

Yes my initial solution was a bit hacky. This needs to be cleaned up.

[julianvmodesto]

Looks like this needs to take into account #251. For long outputs spread across 2 comments, I have seen that the first output renders okay and is in a collapsed block (as implemented in #251), but the second comment is not formatted nicely, as in this issue.

[sstarcher]

I'm seeing the same behavior as @julianvmodesto

[majormoses]

Ya its a known issue not sure the priority /cc @lkysow

[lkysow]

If anyone has bandwidth to take a look that would be great. #203 was started but never finished.

Simply removing the Refreshing.... lines might be a quick-win and move lots of plans under the character limit.