Skip to content

docs: document CI test suite registration requirement#3943

Open
andygrove wants to merge 4 commits intoapache:mainfrom
andygrove:docs/ci-test-suite-registration
Open

docs: document CI test suite registration requirement#3943
andygrove wants to merge 4 commits intoapache:mainfrom
andygrove:docs/ci-test-suite-registration

Conversation

@andygrove
Copy link
Copy Markdown
Member

Which issue does this PR close?

N/A - documentation improvement

Rationale for this change

New Scala test suites must be manually added to the CI workflow files (pr_build_linux.yml and pr_build_macos.yml) so they run in CI. This is not documented anywhere, so contributors may add test suites that pass locally but never run in CI.

What changes are included in this PR?

Adds a new section to the contributor guide (docs/source/contributor-guide/development.md) explaining:

  • That CI does not auto-discover test suites — they must be listed explicitly in both workflow files
  • Why suites are grouped by category (parallel execution to reduce CI time)
  • How to add a new suite, with a YAML example
  • A table mapping each group name (fuzz, shuffle, parquet, csv, exec, expressions, sql) to the area it covers
  • That both workflow files must stay in sync

How are these changes tested?

Documentation-only change. Verified the markdown renders correctly.

New test suites are not automatically discovered by CI. They must be
explicitly added to the suite matrix in both pr_build_linux.yml and
pr_build_macos.yml workflow files. Add a section to the contributor
guide explaining this process, including which groups exist and how
to choose the right one.
The edited event fires when the PR title/body changes, not on new
pushes. Replace with synchronize so the check re-runs when new
commits are pushed to the PR branch.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant