Story (Outcome/Output) (Required)

When converting, integrating or deploying a large number of rules, the size of the GitHub comment can quickly exceed the maximum size limits that GitHub imposes. Such comments should be split into multiple comprehensible comments. Currently, over-sized comments are simply rejected by the GitHub API and lost.

Context

See these (user-tested, undocumented) limits for GitHub comments.

Definition of Done (Required)

A single comment that exceeds the length requirements is split into multiple comments, without breaking the formatting of the comment, whilst adding as few comments as possible.

Implementation Plan

The simple part will be determining if the comment is too long. Breaking apart the comment into smaller ones should respect GitHub's markdown implementation, making sure it splits tables and lists appropriately (repeating table headers if possible), and avoiding headers being placed at the bottom of comments.

Testing Plan

Specific unit tests involving large outputs should suffice.

Dependencies (Required)

GitHub's API changing their limits!