Display issue with split atlantis comments in Github

margueritepd commented 2 years ago

Community Note

Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request. Searching for pre-existing feature requests helps us consolidate datapoints for identical requirements into a single place, thank you!
Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.
If you are interested in working on this issue or have submitted a pull request, please leave a comment.

Overview of the Issue

If the terraform plan is of precisely the right length, then when atlantis breaks it up into multiple comments for Github, the apply instructions which typically appear outside of the <details> element are actually hidden, because the </details> tag is added inside a code block.

The raw markdown for the first comment can be seen here And the second comment here

Basically the assumption that the comment-splitting code makes, that the comment will be split inside a code block, is not holding true, and the addition of code block back-ticks where it doesn't belong is preventing the <details> tags from working correctly.

Environment details

Atlantis version: v0.18.1
If not running the latest Atlantis version have you tried to reproduce this issue on the latest version: No. The code in the current looks to suffer from the same bug.

We run atlantis with Github.

Additional Context

Comment splitting code: https://github.com/runatlantis/atlantis/blob/13fba408273ff8940120e5451f39715afd5d7891/server/events/vcs/github_client.go#L147-L170

jamengual commented 2 years ago

is this still happening with v0.19.8?

margueritepd commented 2 years ago

@jamengual I don't experience this regularly (the terraform output has to be exactly the right length) but the SplitComment and CreateComment code have not changed much since I posted this so I'm pretty sure it is still happening. As you can see the code blindly assumes that it must split the comment with

    ```</details>

which is only appropriate if the comment body already has an un-closed


at the point of splitting which is true most of the time but not always.

margueritepd commented 2 years ago

Can you remove the waiting-on-response label, since I have responded?

jamengual commented 2 years ago

@margueritepd willing to send a PR?

runatlantis / atlantis