name: My Workflow
...
permissions:
  actions: write       # Necessary to cancel workflow executions
  checks: write        # Necessary to write reports
  pull-requests: write # Necessary to comment on PRs
...

jobs:
  ...
  recreate-comment:
    runs-on: ubuntu-latest

    steps:
      - name: Publish Report
        uses: turing85/publish-report@v2
        with:
          checkout: 'true'
          comment-header: my-comment-header
          comment-message-recreate: Hello
          recreate-comment: true
  ...

jobs:
  ...
  test:
    runs-on: ubuntu-latest

    steps:
      - name: Git checkout
        uses: actions/checkout@v4
      ...
      - name: Run Tests
        ...
        continue-on-error: true # the "publish" step will fail, so we get a report when tests failed as well
        ...
      ...
      - name: Publish Report
        uses: turing85/publish-report@v2
        if: ${{ always() }}
        with:
          # cancel-workflow-on-error: 'false' # If we do not want to cancel the whole workflow execution on error
          # checkout: 'true' # not needed; project is already checked out 
          comment-header: my-comment-header
          comment-message-success: |
            YAY! {0} passed!  
            
            {1} tests were successful, {2} tests failed, {3} test were skipped.
            
            The report can be found [here]({4}).

          comment-message-failure: |
            On no! {0} failed!  

            {1} tests were successful, {2} tests failed, {3} test were skipped.

            The report can be found [here]({4}).
          report-fail-on-error: true # to fail when tests failed
          report-name: Tests
          report-path: '**/target/surefire-reports/TEST*.xml'
          report-reporter: java-junit
  ...

...
jobs:
  ...
  test:
    runs-on: ubuntu-latest

    steps:
      - name: Git checkout
        uses: actions/checkout@v4
      ...
      - name: Run Tests
        ...
      ...
      - name: Upload test artifacts
        uses: actions/upload-artifact@v4
        if: ${{ always() }}
        with:
          name: test-report
          path: '**/target/*-reports/TEST*.xml'
          if-no-files-found: error
          retention-days: 2

  test-report:
    runs-on: ubuntu-latest
    
    needs:
      ...
      - test
      ...

    steps:
      - name: Publish Report
        uses: turing85/publish-report@v2
        with:
          ...
          checkout: true
          ...
          download-artifact-name: test-report
          report-path: '**/target/surefire-reports/TEST*.xml'
          ...
  ...

name: Comment on PR

on:
  pull_request_target:
    ...

permissions:
  pull-requests: write

jobs:
  comment:
    runs-on: ubuntu-latest

    steps:
      - name: (Re)create comment
        uses: turing85/publish-report@v2
        with:
          github-token: ${{ github.token }}
          comment-message-recreate: |
            ## 🚦Reports 🚦
            Reports will be posted here as they get available.
          comment-message-pr-number: ${{ github.event.number }}
          recreate-comment: true

name: Build report

on:
  workflow_run:
    workflows:
      - "build"
    types:
      - completed

permissions:
  actions: write
  checks: write
  pull-requests: write

jobs:
  report:
    if: ${{ github.event.workflow_run.event == 'pull_request' }}
    runs-on: ubuntu-latest

    steps:
      - name: Download PR number
        uses: actions/download-artifact@v4
        with:
          github-token: ${{ github.token }}
          name: pr-number
          run-id: ${{ github.event.workflow_run.id }}

      - name: Set PR number
        id: get-pr-number
        run: |
          echo "pr-number=$(cat pr-number.txt)" | tee "${GITHUB_OUTPUT}"
          rm -rf pr-number.txt

      - name: Publish reports
        uses: turing85/publish-report@feature/run-id-and-pr-number
        with:
          comment-message-pr-number: ${{ steps.get-pr-number.outputs.pr-number }}
          download-artifact-name: test-reports
          download-artifact-run-id: ${{ github.event.workflow_run.id }}
          report-name: My Tests
          report-path: '**/target/**/TEST*.xml'

name: Build

on:
  pull_request:
    branches:
      - main
    ...
  push:
    branches:
      - main
    ...

permissions:
  actions: write
  checks: write
  pull-requests: write


jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      ...
      (build the application, generate the test artifacts)
      ...
      - name: Get PR number
        id: get-pr-number
        if: ${{ always() }}
        run: |
          echo "${{ github.event.number }}" > "pr-number.txt"

      - name: Upload PR number
        uses: actions/upload-artifact@v4
        if: ${{ always() }}
        with:
          name: ${{ env.PR_NUMBER_ARTIFACT_NAME }}
          path: pr-number.txt