-
-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Bug] the action adds -
in front of lines starting with @
#35
Comments
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 ;) |
…weifel/changelog-updater-action@v1` (#20) <!-- Thank you for submitting a pull request to our repository. --> ## Description After tracking the different steps it turns out that the action `stefanzweifel/changelog-updater-action@v1` in case of a previous release note including a line like: ``` - Add workflow to clean-up action cache on PR closure xxxxxxxxxxx (PR #8 by @chicco785) ``` changes the content to: ``` - Add workflow to clean-up action cache on PR closure xxxxxxxxxxx (PR #8 by - @chicco785) ``` so, we remove added `-` after the action execution The bug is reported in the original repository stefanzweifel/changelog-updater-action#35, and the workaround can be removed in the future if the issue is solved. ## Changes Made include a step using a sed script to remove the added `-`. ## Related Issues Fixes #21 ## Checklist <!-- Please check off the following items by putting an "x" in the box: --> - [x] I have used a PR title that is descriptive enough for a release note. - [x] I have tested these changes locally. - [x] I have added appropriate tests or updated existing tests. - [ ] I have tested these changes on a dedicated VM or a customer VM [name of the VM] - [ ] I have added appropriate documentation or updated existing documentation. --------- Co-authored-by: Bot <[email protected]>
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 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 ( Or do you expect the final document to keep the original formatting? - 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) |
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. |
Sure, no problem. Enjoy your vacation. |
hi @stefanzweifel basically, we run two workflows:
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 |
Thanks for the feedback. So the wrapping is coming from prettier. |
@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). |
in case of any previous release note including a line like:
the action changes the content to:
The text was updated successfully, but these errors were encountered: