trx-parser 🧹

This Action was inspired by https://github.com/zyborg/dotnet-tests-report

This GitHub Action provides a fast and reliable way of parsing dotnet test results from trx files in a given directory. The action will find trx files specified in the TRX-PATH input variable. This path must be accessible to the action.

The action features parallel processing for improved performance - it will read and process multiple .trx files concurrently, convert them to typed JSON objects, and create GitHub Status checks in parallel. Each TRX file generates a detailed markup report with the report name and title derived from data.TestRun.TestDefinitions.UnitTest[0]._storage.

Reports

The following reports show a failing and a passing check generated by this action.

Workflow Reports:

Usage

To make trx-parser a part of your workflow, just add the following to your existing workflow file in your .github/workflows/ directory in your GitHub repository.

name: Test
on: [pull_request]

jobs:
  Build:
    runs-on: ubuntu-latest
    steps:
      # Replace this whichever way you build your code
      - name: Build & Test dotnet code
        run: |
          dotnet restore
          dotnet build -c Release no-restore
          dotnet test -c Release --no-restore --no-build --logger trx --results-directory ./TestResults
      # Using the trx-parser action
      - name: Parse Trx files
        uses: NasAmin/trx-parser@v0.1
        id: trx-parser
        with:
          TRX_PATH: ${{ github.workspace }}/TestResults #This should be the path to your TRX files
          REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}          

Inputs

Name	Description	Default	Required
TRX_PATH	Path to the directory container your test files	./TestResults	yes
REPO_TOKEN	GitHub token to create status checks	nil	yes
SHA	The commit SHA associated with the checks. This is optional	nil	no
IGNORE_FAILURE	If true, will not set status check as failure.	false	no
REPORT_PREFIX	The prefix for the report name. Useful for matrix builds	nil	no
OTEL_ENABLED	Enable OpenTelemetry telemetry collection	false	no
HONEYCOMB_API_KEY	Honeycomb API key for telemetry export	nil	no
HONEYCOMB_DATASET	Honeycomb dataset name for telemetry	trx-parser	no

✨ Telemetry Support

This action now includes optional telemetry using OpenTelemetry and Honeycomb to help you monitor test execution patterns and performance. Telemetry is disabled by default and requires explicit configuration.

Key Features:

• 📊 Metrics on test execution, success/failure rates, and processing times
• 🔍 Distributed tracing for detailed performance insights
• 🔒 Secure, privacy-focused implementation (no sensitive data collected)
• ⚡ Zero performance impact when disabled

For detailed configuration and usage, see the Telemetry Documentation.

⚠️ GitHub Actions Limitations ⚠️

• The GitHub Checks API has a limit of 65535 characters. So if the test report exceeds this limit, GitHub will fail to create a check and fail your workflow. This was mitigated on #103 and #138 to only report details about failing tests.
• If you have multiple workflows triggered by the same event, currently GitHub Actions will randomly associate a check run to one of the workflows. This is because currently there is no Check Suite API. Only GitHub apps are allowed to create a Check Suite. There is also no way to associate a custom check run with an existing check suite. GitHub actions automatically creates a check suite for each workflow run. However, since check runs are associated with a commit and event, any custom check runs are randomly linked under one of the triggered workflows for the same commit.

Architecture

This action features a modern, modular architecture designed for maintainability and performance:

🏗️ Modular Code Structure

The codebase is organized into focused, single-responsibility modules:

• src/config/constants.ts - Configuration and constants
• src/config/telemetry-config.ts - Telemetry configuration
• src/parsers/trx-parser.ts - TRX file parsing logic
• src/services/github-service.ts - GitHub API operations
• src/services/report-service.ts - Report generation
• src/services/telemetry-service.ts - OpenTelemetry integration
• src/utils/file-utils.ts - File operations
• src/utils/test-analyzer.ts - Test result analysis
• src/validators/input-validator.ts - Input validation

⚡ Performance Features

• Parallel TRX Processing: TRX files are processed concurrently for faster execution
• Parallel Check Creation: GitHub check runs are created in parallel for better throughput
• Optimized Async Patterns: Enhanced async/await usage throughout the codebase

🔧 Modern Dependencies

• TypeScript 5.8.3 with strict mode for enhanced type safety
• Latest stable dependencies with zero security vulnerabilities
• Modern GitHub Actions workflows with improved caching and error handling

Contributing

Anyone is welcome to contribute and make this action better. Please fork the repository and create a pull request with proposed changes.

Development

• Clone this repository
• Install dependencies: npm install
• Build the project: npm run build
• Run tests: npm run test
• Lint code: npm run lint (or npm run lint-fix to auto-fix)
• Format code: npm run format
• Package for distribution: npm run package
• Run all checks: npm run all

The modular architecture makes it easy to:

• Add new TRX parsing features in src/parsers/
• Extend GitHub integrations in src/services/
• Add new validation rules in src/validators/
• Enhance utility functions in src/utils/

Release Process

This repository uses automated releases powered by release-please. When you contribute:

1. Use conventional commit messages (e.g., feat:, fix:, docs:)
2. Release PRs are automatically created when commits are pushed to main
3. Releases are automatically created when release PRs are merged
4. Version numbers and changelogs are automatically generated

See docs/RELEASE.md for detailed information about the release process.