⚠️ DEPRECATION NOTICEThis GitHub Action is deprecated and will no longer be maintained after [June 7, 2026].
We recommend migrating to direct PIP installation for better flexibility and control.
Migration Path: See the Direct PIP Installation section below for instructions on how to use TRCLI directly in your workflows.
GitHub Action to upload automated test results to TestRail using the TestRail CLI. The action handles the installation of the desired CLI version and allows setting all of the configurations supported by the CLI.
- name: Execute TRCLI Action
uses: gurock/trcli-action@main
with:
host: 'https://my-instance.testrail.io/'
username: 'username@testrail.com'
password: 'myPassword123'
project: 'Sample project'
auto_create_cases_yes: 'true'
report_file_path: 'reports/junit-report.xml'
title: 'Automated test run'
run_description: 'GitHub workflow: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}'| Parameter | Description |
|---|---|
trcli_version |
Version of the CLI to be installed (defaults to latest) |
working_directory |
The working directory to execute the TestRail CLI; if not specified, defaults to the GITHUB_WORKSPACE environment variable |
config |
Optional path for config yml file |
host |
TestRail host URL (i.e.: https://my-instance.testrail.io) |
username |
Authentication username |
password |
Authentication password or API key |
project |
Name of the project (alternatively, use the "project_id" parameter) |
project_id |
ID of the project (alternatively, use the "project" parameter) |
verbose |
Output all API calls and their results (default: false) |
verify |
Verify the data was added correctly (default: false) |
insecure |
Allow insecure requests (default: false) |
batch_size |
Configurable batch size (default: 50) |
timeout |
Batch timeout duration (default: 30) |
auto_create_cases_yes |
Automatically create unexisting test cases (true/false) |
auto_create_cases_no |
Skip creation of unexisting test cases (true/false) |
silent |
Silence output (default: false) |
report_file_path |
Path to the JUnit XML file |
title |
Title of Test Run to be created in TestRail |
case_matcher |
Mechanism to match cases between the JUnit report and TestRail (auto/name/property, default: auto) |
close_run |
Close the newly created run (default: false) |
suite_id |
Suite ID where the run will be created in case of a multi-suite project |
run_id |
Run ID to submit results to (by default a new Test Run is created) |
plan_id |
Plan ID with which the Test Run will be associated |
config_ids |
Comma-separated configuration IDs to use along with Test Plans (i.e.: 34,52) |
milestone_id |
Milestone ID to which the Test Run should be associated to |
section_id |
Section ID to create new sections with test cases under |
run_description |
Summary text to be added to the test run |
special_parser |
Optional special parser option for specialized JUnit reports |
allow_ms |
Enable milliseconds for elapsed times (default: false) |
junit_parser_params |
Any parameters, as you would write them on a command line (i.e.: --case-fields type_id:1) |
You can install and use TRCLI directly from PIP in your GitHub Actions workflow:
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install TRCLI
run: pip install trcli
- name: Upload test results to TestRail
env:
TRCLI_HOST: 'https://my-instance.testrail.io/'
TRCLI_USERNAME: ${{ secrets.TESTRAIL_USERNAME }}
TRCLI_PASSWORD: ${{ secrets.TESTRAIL_PASSWORD }}
run: |
trcli -y \
-h "$TRCLI_HOST" \
--project "Sample project" \
-u "$TRCLI_USERNAME" \
-p "$TRCLI_PASSWORD" \
parse_junit \
--title "Automated test run" \
--run-description "GitHub workflow: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}" \
-f "reports/junit-report.xml"For more information on TRCLI and its options, visit the official TRCLI repository.
TestRail CLI is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
TestRail CLI is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.