update docs

Author: jasonwbarnett

README.md

@@ -4,13 +4,13 @@ Buildkite Test Engine Client (bktec) is an open source tool to orchestrate your
 
 bktec supports multiple test runners and offers various features to enhance your testing workflow. Below is a comparison of the features supported by each test runner:
 
-| Feature                                            | RSpec | Jest | Playwright | Cypress | pytest | Go test |
-| -------------------------------------------------- | :---: | :--: | :--------: | :-----: | :----: | :--: |
-| Filter test files                                  |   ✅  |   ✅  |    ✅      |    ✅   |    ✅   |  ❌  |
-| Automatically retry failed test                    |   ✅  |   ✅  |    ✅      |    ❌   |    ✅   |  ✅  |
-| Split slow files by individual test example        |   ✅  |   ❌  |    ❌      |    ❌   |    ❌   |  ❌  |
-| Mute tests (ignore test failures)                  |   ✅  |   ✅  |    ✅      |    ❌   |    ✅   |  ✅  |
-| Skip tests                                         |   ✅  |   ❌  |    ❌      |    ❌   |    ❌   |  ❌  |
+| Feature                                            | RSpec | Jest | Playwright | Cypress | pytest | pants (pytest) | Go test |
+| -------------------------------------------------- | :---: | :--: | :--------: | :-----: | :----: | :----------: | :--: |
+| Filter test files                                  |   ✅  |   ✅  |    ✅      |    ✅   |    ✅   |      ❌      |  ❌  |
+| Automatically retry failed test                    |   ✅  |   ✅  |    ✅      |    ❌   |    ✅   |      ✅      |  ✅  |
+| Split slow files by individual test example        |   ✅  |   ❌  |    ❌      |    ❌   |    ❌   |      ❌      |  ❌  |
+| Mute tests (ignore test failures)                  |   ✅  |   ✅  |    ✅      |    ❌   |    ✅   |      ✅      |  ✅  |
+| Skip tests                                         |   ✅  |   ❌  |    ❌      |    ❌   |    ❌   |      ❌      |  ❌  |
 
 ## Installation
 The latest version of bktec can be downloaded from https://github.com/buildkite/test-engine-client/releases
@@ -60,6 +60,7 @@ To configure the test runner for bktec, please refer to the detailed guides prov
 - [Playwright](./docs/playwright.md)
 - [Cypress](./docs/cypress.md)
 - [pytest](./docs/pytest.md)
+- [pytest pants](./docs/pytestpants.md)
 - [go test](./docs/gotest.md)
 - [RSpec](./docs/rspec.md)
 

docs/pytestpants.md

@@ -1,11 +1,22 @@
-# Using bktec with pants
+# Using bktec with pants (Experimental)
+
+> [!WARNING]
+> Pants support is currently experimental and has limited feature support. Only the following features are supported:
+> - Automatically retry failed tests
+> - Mute tests (ignore test failures)
+>
+> The following features are not supported:
+> - Filter test files
+> - Split slow files by individual test example
+> - Skip tests
+
 To integrate bktec with pants, you need to [install and configure Buildkite Test Collector for pytest](https://buildkite.com/docs/test-engine/python-collectors#pytest-collector) first. Then set the `BUILDKITE_TEST_ENGINE_TEST_RUNNER` environment variable to `pytestpants`.
 
-Look at the example configuration files in the [pytest_pants testdata directory](https://github.com/buildkite/test-engine-client/tree/main/internal/runner/testdata/pytest_pants) for an example of how to add buildkite-test-collector to the pants resolve used by pytest. Specifically:
+Look at the example configuration files in the [pytest_pants testdata directory](../internal/runner/testdata/pytest_pants) for an example of how to add buildkite-test-collector to the pants resolve used by pytest. Specifically:
 
-- [pants.toml](https://github.com/buildkite/test-engine-client/blob/main/internal/runner/testdata/pytest_pants/pants.toml) - pants configuration
-- [3rdparty/python/BUILD](https://github.com/buildkite/test-engine-client/blob/main/internal/runner/testdata/pytest_pants/3rdparty/python/BUILD) - python_requirement targets
-- [3rdparty/python/pytest-requirements.txt](https://github.com/buildkite/test-engine-client/blob/main/internal/runner/testdata/pytest_pants/3rdparty/python/pytest-requirements.txt) - Python requirements.txt
+- [pants.toml](../internal/runner/testdata/pytest_pants/pants.toml) - pants configuration
+- [3rdparty/python/BUILD](../internal/runner/testdata/pytest_pants/3rdparty/python/BUILD) - python_requirement targets
+- [3rdparty/python/pytest-requirements.txt](../internal/runner/testdata/pytest_pants/3rdparty/python/pytest-requirements.txt) - Python requirements.txt
 
 In the example in the repository, you would need to generate a lockfile next, i.e.