add-comment@v1 backticks causing format issues in dry run output

[michaeldrotar]

Describe the bug

There's an extra backtick here:

which misformats here

it should render like this

• to add the following reviewers johnlock

To Reproduce

Steps to reproduce the behavior:

• I'm using this automation

  assign_previous_contributors:
    if:
      - {{ not pr.draft }}
    run:
      - action: add-comment@v1
        args:
          comment: |
            {{ repo | explainRankByGitBlame(gt=25) | dump | safe }}
      - action: add-reviewers@v1
        args:
          reviewers: {{ repo | rankByGitBlame(gt=25) }}

• and then running it in dry mode

Expected behavior

it should output without the extra backtick so it renders like this

• to add the following reviewers johnlock

Screenshots

If applicable, add screenshots to help explain your problem.

Additional context

Afer looking more closely, this happens anytime using add-comment@v1 cause it seems to assume a short single-line comment like

• add comment foo bar baz

but if you do a multi-line comment, like the explainRankByGitBlame dump, then you get a leading backtick as well before the comment and that tailing one causing mis-formatting

can see the leading one here:

it would probably be better to have add-comment@v1 start the comment on the next line and not add any of its own formatting in dry run

[vim-zz]

@michaeldrotar can you re-check this?

[deiga]

@vim-zz We're seeing similar behaviour!

[BenLloydPearson]

I have an update to share on this. Our roadmap contains plans to rework gitStream testing capabilities over the next couple of months, and this will be either fixed or reworked as part of that initiative. Stay tuned!