Delete markdown comments

[seanogdev]

Describe the bug Not sure if this is on teamwork or this addons end, but seeing markdown comments come through as part of the Teamwork comment

To Reproduce Steps to reproduce the behavior:

1. Create a PR with a markdown comment <!-- Test comment -->
2. Test comment rendered as a string in Teamwork comment

   <!-- Test comment -->

Expected behavior That markdown comments would not be rendered

[Flexicon]

Hey, what's a real use-case for adding markdown comments to a PR that you don't want to be published to TW?

Just looking for context here 🤔

[seanogdev]

In a lot of PR templates theres often comments like

<!-- Add a link to the task -->

or

<!-- Add a description -->

I dont think thats really valuable in being rendered in Teamwork, curious as to what you think?

[Flexicon]

Ah right fair play. I just saw it there in the PR template for this repo as well. I wasn't aware that that was a feature of Github flavour markdown but yeah I agree. No real value there.

I think that's a thing for the projects Markdown renderer at this point though, unless we use sed or awk to strip out those comments before sending. Might be more trouble than it's worth though at that point.

[seanogdev]

Happy to close if you think so then 👍

[Flexicon]

Yeah I think this should be closed, because from reading this it looks like those html style comments are not a part of standard markdown but just something github allows.

That said, there is a hacky approach to making Markdown "comments" that pretty much any markdown renderer will respect (including the one projects uses, see below) and it is mentioned in that StackOverflow thread too.

markdown	rendered

[seanogdev]

does that work in gh flavour markdown 🤔 ?

[Flexicon]

Yep

☝️

[Flexicon]

Again, that's because it's part of the standard markdown syntax, not anything fancy. Just "abusing" link/image labels.