[Bug] the action adds - in front of lines starting with @

[chicco785]

in case of any previous release note including a line like:

- Add workflow to clean-up action cache on PR closure xxxxxxxxxxx (PR #8 by
  @chicco785)

the action changes the content to:

- Add workflow to clean-up action cache on PR closure xxxxxxxxxxx (PR #8 by
- @chicco785)

[stefanzweifel]

Thanks for reporting!

This sounds weird, but I will try to confirm this issue in the coming days. Might be, that the issue lies in an upstream dependency that converts the text to markdown.

[chicco785]

Thanks for reporting!

This sounds weird, but I will try to confirm this issue in the coming days. Might be, that the issue lies in an upstream dependency that converts the text to markdown.

it took me a while to dig down to the source of the issue, hopefully i didn't it wrong :) no worries, at the moment I solved adding a step with a sed command after your action ;)

[stefanzweifel]

I was able to reproduce this issue. The error is not happening in this project, but in a dependency down the line which I also maintain. 😎

I've opened a PR with the failing test here: stefanzweifel/commonmark-markdown-renderer#7
The code in question, that breaks this is ListItemRenderer.php and ListBlockRenderer.php.

---

All markdown rendering apps that I use (Obsidian, iA Writer) convert the example you provided to a single line item without a line break in it.

So this …

- Add workflow to clean-up action cache on PR closure xxxxxxxxxxx (PR #8 by
  @chicco785)

turns into this.

<li>Add workflow to clean-up action cache on PR closure xxxxxxxxxxx (PR #8 by @chicco785)</li>

I would adopt this logic and update the package, to replace all line breaks (\n) in a list item with a space ( ).
Otherwise I would have to rewrite the ListBlockRenderer.php to distinguish line items differently. (And I have no idea how I could do that right now.)

Or do you expect the final document to keep the original formatting?
To be this:

- Add workflow to clean-up action cache on PR closure xxxxxxxxxxx (PR #8 by
  @chicco785)

instead of this:

- Add workflow to clean-up action cache on PR closure xxxxxxxxxxx (PR #8 by @chicco785)

[chicco785]

I think the problem may be related to the combination of your code with prettier.io. I am currently on holidays, so I can’t provide more details right now, but will be happy to do so in 2 weeks.

[stefanzweifel]

Sure, no problem. Enjoy your vacation.

[chicco785]

hi @stefanzweifel
i am back :)

basically, we run two workflows:

1. generates release release notes (https://github.com/zaphiro-technologies/github-workflows/blob/main/.github/workflows/release-notes.yaml)
2. check and pretty markdown (https://github.com/zaphiro-technologies/github-workflows/blob/main/.github/workflows/markdown.yaml)

so when release notes are updated, the workflows are triggered again, and the prettier changes the formatting of the release notes. the combination of the two actions may cause the weird behaviour. since, the prettier act on the release note and breaks it into multiple lines, and then the release note action process it again adding to the start of the new line the -, despite this is still actually part of the existing bullet. (I hope it's clear)

[stefanzweifel]

Thanks for the feedback. So the wrapping is coming from prettier.
I think I will simply fix and merge my PR here and update all upstream projects accordingly.

[stefanzweifel]

@chicco785 This issue should now be fixed.

As always, this was a bit more complex than expected. The Markdown-to-Markdown converter couldn't handle multi-line list items yet. This has now been fixed in stefanzweifel/commonmark-markdown-renderer#7.

The underlying CLI of this Action has been updated as well (stefanzweifel/php-changelog-updater#44).