Skip to content

task-release: Fix the formatting of the Markdown it writes - #119

Merged
jtrobles-cdd merged 2 commits into
developfrom
claude/release-deploy-notification-format-128b67
Sep 14, 2026
Merged

jtrobles-cdd merged 2 commits into
developfrom
claude/release-deploy-notification-format-128b67

Conversation

@jtrobles-cdd

@jtrobles-cdd jtrobles-cdd commented Sep 14, 2026 •

Copy link
Copy Markdown
Member

The task writes Markdown in two places, the job summary and the checklist comment, and both came out malformed because of how GitHub renders it: every newline of a comment becomes a line break, and the summary of each step is a Markdown document of its own that GitHub joins to the next with a blank line. The reviewers, written by a later step than the rest of the summary, came out as a list of their own rather than as the last item of the list above them.

Job summary

  • The summary step runs unless the run was cancelled, rather than only on success, so a failure after the pull request was opened still leaves its URL in the summary. Before, whichever chunk had already been written survived and the rest did not.
  • - **Reviewers:** nobody now depends on request_reviews_from_change_authors being on, rather than on the review step having run at all.

Checklist comment

  • The continuation of the common pre-deployment item was aligned under the text it continues, and that alignment survived the line join as a run of seven spaces in the comment body. The diff shows only the removed spaces.
  • Both *_deployment_checklist_items inputs now state that an item must not be hard-wrapped. Nothing said so before, which is how wrapped items reached a comment.

Not fixed here

  • The wrapped items somebody reported on a checklist comment come from a caller's own input, not from this repository, and are tracked there.

@jtrobles-cdd jtrobles-cdd added the bug Something isn't working label Sep 14, 2026
@jtrobles-cdd jtrobles-cdd self-assigned this Sep 14, 2026
- GitHub renders the summary of each step as a Markdown document of its own and joins them with a
  blank line, so the reviewers, written by a later step than the rest, ended up as a list of their
  own rather than as the last item of the one above them.
- The summary is therefore written last, by a step that does nothing else, out of the outputs of
  the steps that produced the values. The step that requests the reviews now records the users in
  outputs instead of writing them to the summary itself.
- The step runs unless the run was cancelled, rather than only on success, so that a failure after
  the pull request was opened still leaves its URL in the summary.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@jtrobles-cdd
jtrobles-cdd force-pushed the claude/release-deploy-notification-format-128b67 branch from 62ec126 to be4616e Compare September 14, 2026 14:20
@jtrobles-cdd jtrobles-cdd changed the title task-release: Fix the formatting of the job summary and the checklist task-release: Fix the formatting of the Markdown it writes Sep 14, 2026
- GitHub renders every newline of a comment as a line break, so a hard-wrapped checklist item
  reaches the pull request broken across lines. The items this workflow contributes were already
  joined by a line continuation, but nothing said so to the callers that supply their own, and
  theirs arrive wrapped. The description of both inputs now states it.
- The continuation of the common pre-deployment item was aligned under the text it continues, and
  that alignment survived the join as a run of seven spaces in the comment body. It now continues
  without indentation, as the tip above it already does.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@jtrobles-cdd
jtrobles-cdd force-pushed the claude/release-deploy-notification-format-128b67 branch from be4616e to e4651a0 Compare September 14, 2026 14:26
@sonarqubecloud

Copy link
Copy Markdown

@jtrobles-cdd
jtrobles-cdd merged commit 6e18f61 into develop Sep 14, 2026
8 checks passed
@jtrobles-cdd
jtrobles-cdd deleted the claude/release-deploy-notification-format-128b67 branch September 14, 2026 14:33
@jtrobles-cdd jtrobles-cdd mentioned this pull request Sep 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant