You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafusion.apache.org by ag...@apache.org on 2026/04/18 12:18:00 UTC
(datafusion-comet) branch main updated: docs: document CI test suite registration requirement (#3943)
This is an automated email from the ASF dual-hosted git repository.
andygrove pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-comet.git
The following commit(s) were added to refs/heads/main by this push:
new 42396b012 docs: document CI test suite registration requirement (#3943)
42396b012 is described below
commit 42396b012477ab26139dcf9f6124ab279082048e
Author: Andy Grove <ag...@apache.org>
AuthorDate: Sat Apr 18 06:17:56 2026 -0600
docs: document CI test suite registration requirement (#3943)
---
.github/workflows/pr_missing_suites.yml | 5 +++-
docs/source/contributor-guide/development.md | 41 ++++++++++++++++++++++++++++
2 files changed, 45 insertions(+), 1 deletion(-)
diff --git a/.github/workflows/pr_missing_suites.yml b/.github/workflows/pr_missing_suites.yml
index 89589c26c..be944dbdb 100644
--- a/.github/workflows/pr_missing_suites.yml
+++ b/.github/workflows/pr_missing_suites.yml
@@ -18,8 +18,11 @@
name: Check that all test suites are added to PR workflows
on:
+ push:
+ branches:
+ - main
pull_request:
- types: [opened, edited, reopened]
+ types: [opened, synchronize, reopened]
jobs:
check-missing-suites:
diff --git a/docs/source/contributor-guide/development.md b/docs/source/contributor-guide/development.md
index 47f034c97..d7c07c30b 100644
--- a/docs/source/contributor-guide/development.md
+++ b/docs/source/contributor-guide/development.md
@@ -438,6 +438,47 @@ make test-rust
make test-jvm
```
+### 5. Register New Test Suites in CI
+
+Comet's CI does not automatically discover test suites. Instead, test suites are explicitly listed
+in the GitHub Actions workflow files so they can be grouped by category and run as separate parallel
+jobs. This reduces overall CI time.
+
+If you add a new Scala test suite, you must add it to the `suite` matrix in **both** workflow files:
+
+- `.github/workflows/pr_build_linux.yml`
+- `.github/workflows/pr_build_macos.yml`
+
+Each file contains a `suite` matrix with named groups such as `fuzz`, `shuffle`, `parquet`, `csv`,
+`exec`, `expressions`, and `sql`. Add your new suite's fully qualified class name to the
+appropriate group. For example, if you add a new expression test suite, add it to the
+`expressions` group:
+
+```yaml
+- name: "expressions"
+ value: |
+ org.apache.comet.CometExpressionSuite
+ # ... existing suites ...
+ org.apache.comet.YourNewExpressionSuite # <-- add here
+```
+
+Choose the group that best matches the area your test covers:
+
+| Group | Covers |
+| ------------- | ---------------------------------------------------------- |
+| `fuzz` | Fuzz testing and data generation |
+| `shuffle` | Shuffle operators and related exchange behavior |
+| `parquet` | Parquet read/write and native reader tests |
+| `csv` | CSV native read tests |
+| `exec` | Execution operators, joins, aggregates, plan rules, TPC-\* |
+| `expressions` | Expression evaluation, casts, and SQL file tests |
+| `sql` | SQL-level behavior tests |
+
+**Important:** The suite lists in both workflow files must stay in sync. A separate CI check
+(`.github/workflows/pr_missing_suites.yml`) runs `dev/ci/check-suites.py` on every pull request.
+It scans for all `*Suite.scala` files in the repository and verifies that each one appears in both
+workflow files. If any suite is missing, this check will fail and block the PR.
+
### Pre-PR Summary
```sh
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org