Skip to content

fix(reports): update target description to output correctly in markdown #5309

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

Merged
merged 1 commit into from
Jun 3, 2025

Conversation

mcwarman
Copy link
Member

@mcwarman mcwarman commented Jun 3, 2025

Again in my battle with markdown reports for bitbucket i noticed a bug in the descriptions.

We use ...\n\t* ... throughout the code (here, here and here), this doesn't output correctly in GitHub or Bitbucket (and probably GitLab) but haven't checked.

This can be replicated in common mark tester here

GitHub Example

image

Ref: #5291

Bitbucket Before

image

Bitbucket After

image

Test

To test this pull request, you can run the following commands:

cd pkg/core/reports
go test

Additional Information

Checklist

  • I have updated the documentation via pull request in website repository.

Tradeoff

Potential improvement

@mcwarman mcwarman requested a review from olblak June 3, 2025 07:46
@mcwarman mcwarman changed the title feat(reports): update target description to output correctly in markdown fix(reports): update target description to output correctly in markdown Jun 3, 2025
@mcwarman mcwarman force-pushed the feat/target-descriptions branch from 9735cd5 to 28b1967 Compare June 3, 2025 08:55
@mcwarman mcwarman marked this pull request as ready for review June 3, 2025 08:56
@mcwarman
Copy link
Member Author

mcwarman commented Jun 3, 2025

This might not fix it in GitHub, because it looks to do some very deliberate escaping.

@olblak olblak added bug Something isn't working actions labels Jun 3, 2025
Copy link
Member

@olblak olblak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch.
I never noticed it

@olblak olblak merged commit dcf16c1 into updatecli:main Jun 3, 2025
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants