Tricks of using cargo-pretty-test in CI

[zjp-CN]

• Install: cargo install cargo-pretty-test
• Use --color=always to force print in color: e.g. cargo pretty-test --color=always (demo)

• Use --color=never (to prevent escape chars) and $GITHUB_STEP_SUMMARY to print testing result in workflow summary (demo) Note: $GITHUB_STEP_SUMMARY will take the input as GFM (a markdown format), so you should put the result in text mode, like

  echo -n "<pre>" >> $GITHUB_STEP_SUMMARY
  echo -n "$(cargo pretty-test --color=never)" >> $GITHUB_STEP_SUMMARY
  echo -n "</pre>" >> $GITHUB_STEP_SUMMARY
  
  # or
  echo '```text' >> $GITHUB_STEP_SUMMARY
  echo "$(cargo pretty-test --color=never)" >> $GITHUB_STEP_SUMMARY
  echo '```' >> $GITHUB_STEP_SUMMARY

  

[josecelano]

This is an example:

• https://github.com/josecelano/cargo-pretty-test/actions/runs/6391336688
• https://github.com/josecelano/cargo-pretty-test/blob/main/.github/workflows/testing.yaml#L111-L118

@zjp-CN do you want to add this to the README? or create a docs folder?

[zjp-CN]

Yes, and it's already there. https://github.com/josecelano/cargo-pretty-test/commit/08b0638dd35d8e5a536f54f9631198f4914f424e

[josecelano]

Yes, and it's already there. 08b0638

Cool! So I suppose we can close this issue.