What happens
descriptionMarkdown in src/sections/update-description.ts replaces every blank line in a description's prose with <br />. A description written as block Markdown, such as a list, a heading or a second paragraph, becomes a single paragraph with line breaks.
description: |
Does things.
- Run:
```yaml
uses: x
```It is written as:
Does things.<br />- Run:
```yaml
uses: x
```The list is gone. The fence is kept verbatim (since #709), but it no longer sits in a list item, so its four-space indentation renders it as an indented code block.
Why it is filed separately
The <br /> conversion predates #690. Since #690, each span is padded and formatted as its own Markdown document, so blank lines could stay as they are. Removing the conversion changes the description section of every README whose action description has a blank line, so it wants its own change and a decision on whether it is breaking.
Suggested direction
Keep the description's blank lines, and let prettier format the span as block Markdown. The contract verifier builds its expected description with the same rule, so update it in the same change.
What happens
descriptionMarkdowninsrc/sections/update-description.tsreplaces every blank line in a description's prose with<br />. A description written as block Markdown, such as a list, a heading or a second paragraph, becomes a single paragraph with line breaks.It is written as:
The list is gone. The fence is kept verbatim (since #709), but it no longer sits in a list item, so its four-space indentation renders it as an indented code block.
Why it is filed separately
The
<br />conversion predates #690. Since #690, each span is padded and formatted as its own Markdown document, so blank lines could stay as they are. Removing the conversion changes the description section of every README whose action description has a blank line, so it wants its own change and a decision on whether it is breaking.Suggested direction
Keep the description's blank lines, and let prettier format the span as block Markdown. The contract verifier builds its expected description with the same rule, so update it in the same change.