From 02a4b6fa0d258e126bb38db37b0b3e1e7cab6ef4 Mon Sep 17 00:00:00 2001 From: acuanico-tr-galt Date: Fri, 9 Oct 2026 19:10:01 +0800 Subject: [PATCH] TR-22345: Added short README update for automatic creation of Automation ID field --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c72c9cd..b6f7934 100644 --- a/README.md +++ b/README.md @@ -407,10 +407,19 @@ while the second one is suited for a specification-first approach, where you wri > otherwise the CLI tool will attempt to find the suite on TestRail or create it. #### 1. Using Automation ID (code-first approach) -To use this mechanism, you must first add a new [custom field](https://www.gurock.com/testrail/docs/user-guide/howto/fields/) +To use this mechanism, you must first add a new [custom field](https://www.gurock.com/testrail/docs/user-guide/howto/fields/) of type `Text` with system name `automation_id`. -The TestRail CLI will use the unique combination of your automation test case’s `classname` and `name` +> **Auto-creating the automation_id field:** If the `automation_id` field doesn't exist yet in your +> TestRail instance, the CLI can create it for you (scoped to your current project, not globally) +> the next time it runs with `--case-matcher auto` and either `-y` or an interactive `yes` response. +> This requires TestRail Administrator rights for the account/API key being used; if the account +> lacks permission, the CLI will show a specific error explaining that admin rights are required. +> If the field already exists but is inactive or not scoped to your project, the CLI will **not** +> attempt to create a duplicate - you'll need to fix its configuration manually in the TestRail +> Administration under Customizations > Case Fields, as described below. + +The TestRail CLI will use the unique combination of your automation test case’s `classname` and `name` (expressed as `classname.name`) to compare against values of the `automation_id` field in your TestRail test case repository. If a match is found, this test case will be included in the auto-generated test run for this upload.