Skip to content

docs: derive CI module lists from the poms that declare them, not a hard-coded list - #25986

Merged
Artur- merged 2 commits into
mainfrom
guidelines-bot/2026-09-28-137262a79504b924
Sep 28, 2026
Merged

Artur- merged 2 commits into
mainfrom
guidelines-bot/2026-09-28-137262a79504b924

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

What this proposes

A script or CI workflow must read the set of modules it iterates over from the
poms that declare them (a <module> list, or a per-module marker such as
validation.run), rather than carrying a hard-coded module list that drifts
when someone adds a module.

Where it came from

Rule Seen in Raised by Evidence How I checked it landed
Derive module lists from the poms #25919, #25736 @Artur-, @mcollovati comment, comment Merged code obeys (signal 1). scripts/previewModule.js:50-63 on main now reads <module> from flow-tests/pom.xml ("so that a new test module is picked up without listing it anywhere"); .github/workflows/validation.yml:97,510-512 derives the Quarkus matrix from the validation.run POM marker via scripts/computeMatrix.js:452-465.

Window: 53 merged pull requests from the last 7 days (62 merged total; 9
dependency bumps skipped).

Counter-example check: grepped scripts/ and .github/workflows/ for module
handling. Compliance dominates — computeMatrix.js, previewModule.js and
previewPackage.sh all parse <module>/validation.run from poms; the central
matrix is entirely pom-derived. The one -pl test-devloop-*/devloop-shared
line in validation.yml:281 is a targeted build-prerequisite command for two
shared submodules, not a maintained module inventory, so it is not a
counter-example.

Why it is worth a rule

Two reviewers, on two unrelated pull requests, made the same call by hand:
Artur on a preview-deploy script ("This should not list all modules, nobody
will remember to update them"), and mcollovati on the Quarkus CI matrix
("Having the modules hard-coded here looks a bit difficult to maintain... have
the configuration in the pom.xml, where the modules are actually defined").
Both authors reworked the code to read from the poms. A reader of the new
paragraph writing the next CI script will derive the list up front instead of
being told to in review, and a stale hard-coded list — the kind that silently
skips a new module from a test run — is caught at authoring time.

Considered and dropped

Review notes

  • Docs only: CONVENTIONS.md. No code, tests or build files.
  • The wording is a proposal. Rewriting it in review is cheaper than closing it.
  • Closing this without merging tells the bot never to propose these rules
    again.

Auto-generated by Guidelines Bot from review comments on merged pull requests.

Generated by Guidelines Bot · ◷

  • expires on Oct 12, 2026, 8:25 AM UTC

Add a Build & Dependencies convention: a script or CI workflow must read
the set of modules it iterates over from the poms that declare them,
instead of carrying a hard-coded list that drifts when a module is added.

Distilled from review comments on merged pull requests #25919 and #25736.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Artur-
Artur- marked this pull request as ready for review September 28, 2026 12:26
@Artur-
Artur- enabled auto-merge September 28, 2026 12:26
@sonarqubecloud

Copy link
Copy Markdown

@github-actions

Copy link
Copy Markdown
Contributor Author

Test Results

 1 551 files  ±0   1 635 suites  ±0   1h 36m 15s ⏱️ - 4m 49s
12 467 tests ±0  12 395 ✅ ±0  72 💤 ±0  0 ❌ ±0 
12 866 runs  ±0  12 794 ✅ ±0  72 💤 ±0  0 ❌ ±0 

Results for commit f900825. ± Comparison against base commit 7515b5a.

@Artur-
Artur- added this pull request to the merge queue Sep 28, 2026
Merged via the queue into main with commit 5dbec88 Sep 28, 2026
48 checks passed
@Artur-
Artur- deleted the guidelines-bot/2026-09-28-137262a79504b924 branch September 28, 2026 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant