atlantis icon indicating copy to clipboard operation
atlantis copied to clipboard

feat: Reverse PR Comments Order

Open wpbeckwith opened this issue 2 years ago • 6 comments

what

This PR reverses the order of PR comments so that when they are posted to a PR, they will read from top to bottom as a logical block.

why

Assume there is a big terraform long that will be posted and it will be donme as 2 separate comments. The current behavior will post comments block 3, then 2 and finally 1. his causes users to need to scroll to the 1st comment block, read down, then scroll back up past the beginng of the 1st block and to find the beginiing of block 2 and read down, then repeat that process for block 3.

tests

There is a simple function that just reverses the slice array and there's a test for that function. We have also been running this in production for 1.5 years with 100's of PR builds a day.

references

  • closes https://github.com/runatlantis/atlantis/issues/2547

wpbeckwith avatar Dec 01 '23 18:12 wpbeckwith

I think I have all the config settings in place. I just need to know how to read the config setting in the various clients to make the logic conditional.

wpbeckwith avatar Dec 01 '23 18:12 wpbeckwith

This is not something I've seen personally on GitHub. Which VCS do you use? Maybe this issue is specific to that one? In that case, I'd approach this as a bug and make the correct way the new default. Not sure what the maintainers think?

kvanzuijlen avatar Dec 12 '23 22:12 kvanzuijlen

This is not something I've seen personally on GitHub. Which VCS do you use? Maybe this issue is specific to that one? In that case, I'd approach this as a bug and make the correct way the new default. Not sure what the maintainers think?

Have you had PR comments larger than 65k?

wpbeckwith avatar Dec 12 '23 22:12 wpbeckwith

Have you had PR comments larger than 65k?

I've had plans spanning multiple comments, so I guess so.

kvanzuijlen avatar Dec 12 '23 23:12 kvanzuijlen

@brandon-fryslie, you mentioned in #3905 frequently having output split across multiple comments; do you have an opinion about whether the current ordering should be default, the reverse, or if it should be configurable?

lukemassa avatar Dec 18 '23 05:12 lukemassa

This issue is stale because it has been open for 1 month with no activity. Remove stale label or comment or this will be closed in 1 month.

github-actions[bot] avatar Jun 25 '24 01:06 github-actions[bot]