PR Summaries

Solemly can write a summary of each pull request's change into its description, so reviewers see what changed at a glance.

How it works#

• The summary goes in its own block in the description. Your own text is never changed.
• Each new review replaces the block, so the summary stays current and you never get more than one.
• On GitHub, the Solemly / Summary check reports Summary written, or No summary when there was nothing to summarize.

Turn it on or off#

PR summary is a per-repository setting in Repository Settings. It's on for repositories connected recently. Repositories connected before summaries became the default keep it off until you turn it on.

Write a summary on demand#

Comment @solemly describe on any pull request to write or refresh the summary, whatever the setting.

Editing the summary#

The summary sits in a marked block of the description. Edit anything outside it freely. Changes inside the block are replaced on the next review.