junit-monorepo-go

This action displays the CI results of multi-module monorepos in Go by commenting on a PR and an Actions summary page.

Usage

Directory structure

This action assumes that there are multiple Go modules in the monorepo with a go.mod file for each module. JUnit test reports are generated with gotestsum and golangci-lint and should be stored in the root of each module.

go
├── app1
│   ├── pkg/
│   ├── go.mod
│   ├── lint.xml
│   └── test.xml
├── app2
│   ├── pkg/
│   ├── go.mod
│   ├── lint.xml
│   └── test.xml
└── app3
    ├── pkg/
    ├── go.mod
    ├── lint.xml
    └── test.xml

Workflow

name: Test
on:
  pull_request:
    branches:
      - main

jobs:
  test:
    name: Test
    runs-on: ubuntu-latest
    permissions:
      contents: read
    strategy:
      fail-fast: false
      matrix:
        directory: ['go/app1', 'go/app2']
    steps:
      - name: Checkout Code
        uses: actions/checkout@v4
      - name: Setup go
        uses: actions/setup-go@5
      - name: Install golangci-lint
        run: go install github.com/golangci/golangci-lint
      - name: Install gotestsum
        run: go install gotest.tools/gotestsum@latest
      - name: Test
        id: test
        working-directory: ${{ matrix.directory }}
        env:
          directory: ${{ matrix.directory }}
        run: |-
          echo "name=$(echo "${directory}" | tr '/' '-')" >> "${GITHUB_OUTPUT}"
          gotestsum \
            --format github-actions \
            --junitfile test.xml \
            --junitfile-testcase-classname relative \
            --junitfile-testsuite-name relative \
            ./...
      - name: Lint
        id: lint
        working-directory: ${{ matrix.directory }}
        run: |-
          golangci-lint --out-format github-actions,junit-xml:lint.xml
      - name: Update artifacts
        uses: actions/upload-artifact@v4
        with:
          name: junit-${{ steps.test.outputs.name }}
          # NOTE: ** preserves the directory structure
          path: |
            **/test.xml
            **/lint.xml

  report:
    name: Report
    runs-on: ubuntu-latest
    needs: test
    permissions:
      issues: write
      actions: write
    steps:
      - name: Download artifacts
        uses: actions/download-artifact@v4
        with:
          pattern: junit-*
          merge-multiple: true
      - name: Comment PR
        uses: tapihdev/junit-monorepo-go@v0
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          config: |
            test:
              title: Test
              type: gotestsum
              fileName: test.xml
              directories:
              - go/app1
              - go/app2
            lint:
              title: Lint
              file: golangci.toml
              type: golangci-lint
              fileName: lint.xml
              directories:
              - go/app1
              - go/app2

Inputs

Important

Please keep in mind that left join is performed on the test and lint reports configured in the config

Input	Required	Description
github-token	yes	The GitHub token to use for authentication
config	yes	YAML-style configuration to define how to parse the test and lint reports (See JSON schema for details)
pull-request-number	no	The pull request number to comment on
sha	no	The commit SHA of the pull request

Outputs

A full set list of possible output values for this action.

Output	Description
body	The body of the comment

PR run permissions

This action requires the issues: write and actions: write permissions.