mimir icon indicating copy to clipboard operation
mimir copied to clipboard

[mimir-rules-action] fix multiline output expression

Open rasta-rocket opened this issue 6 months ago • 1 comments

Signed-off-by: rasta-rocket [email protected]

What this PR does

Hey folks 👋

Small PR that fix/simplify the way the multiline is rendered in the output of the action mimir-rules-action

With the following pipeline:

name: mimir_rules_ci
on:
  workflow_dispatch:
  pull_request:
jobs:
  mimir_rules:
    name: Check Mimir Rules
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Check Mimir rules
        uses: rasta-rocket/mimir/operations/mimir-rules-action@action_mimirtool_fix_multiline
        env:
          MIMIR_ADDRESS: "XXXXX"
          MIMIR_TENANT_ID: XXXXX
          ACTION: check
          RULES_DIR: "./mimir/alert,./mimir/record"
      - name: Diff Mimir rules
        id: diff_rules
        uses: rasta-rocket/mimir/operations/mimir-rules-action@action_mimirtool_fix_multiline
        env:
          MIMIR_ADDRESS: "XXXXX"
          MIMIR_TENANT_ID: XXXXX
          ACTION: diff
          RULES_DIR: "./mimir/alert,./mimir/record"
      - name: Put diff in summary
        run: |
           echo "${{ steps.diff_rules.outputs.detailed }}"

           echo '# Diff summary' >> $GITHUB_STEP_SUMMARY
           echo '```diff' >> $GITHUB_STEP_SUMMARY
           echo "${{ steps.diff_rules.outputs.detailed }}" >> $GITHUB_STEP_SUMMARY
           echo '```' >> $GITHUB_STEP_SUMMARY

This has been done following : https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#example-of-a-multiline-string

Don't hesitate to ping me if any remarks/questions 😉 ?

Cheers ☀️

Which issue(s) this PR fixes or relates to

Fixes #

Checklist

  • [ ] Tests updated.
  • [ ] Documentation added.
  • [ ] CHANGELOG.md updated - the order of entries should be [CHANGE], [FEATURE], [ENHANCEMENT], [BUGFIX].
  • [ ] about-versioning.md updated with experimental features.

rasta-rocket avatar Aug 19 '24 17:08 rasta-rocket