Skip to content

docs(config): document that groups compose via flows, not nesting - #54

Merged
quike merged 1 commit into
mainfrom
docs/group-composition
Sep 16, 2026
Merged

quike merged 1 commit into
mainfrom
docs/group-composition

Conversation

@quike

@quike quike commented Sep 16, 2026

Copy link
Copy Markdown
Owner

Closes #37.

Item 3 of #37 asked for a decision, not code: should commands: entries be able to call another group, the way Taskfile allows {task: other-task}?

Decision: won't do. This documents it so the question does not come back as an undocumented gap.

The reasoning, as laid out in #37: a group is keepup's atomic unit — one cache fingerprint, one require:/skip-if: gate, one node in the graph. Nesting would have to answer whose cache: applies, whose gating runs, and what a cache hit on the inner group means for the outer one, while re-creating the ordering steps:/run: already express.

Adds a Groups do not nest section to docs/CONFIG.md stating the rule, the reasoning, and the idiom to use instead — extract the shared work into its own group and name it from both flows — with a worked example. It ends by inviting a reopen if someone has a case that neither commands: nor a flow can express, since a documented decision should not be a closed door.

Docs only; no behaviour change.

With items 1 (#52) and 2 (#53) already merged, this retires #37.

@codecov

codecov Bot commented Sep 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.97%. Comparing base (d8653eb) to head (2e393cd).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #54   +/-   ##
=======================================
  Coverage   92.97%   92.97%           
=======================================
  Files          27       27           
  Lines        1565     1565           
=======================================
  Hits         1455     1455           
  Misses        107      107           
  Partials        3        3           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@quike
quike merged commit 5ffdb24 into main Sep 16, 2026
4 checks passed
@quike
quike deleted the docs/group-composition branch September 16, 2026 20:24
@quike

quike commented Sep 16, 2026

Copy link
Copy Markdown
Owner Author

🎉 This PR is included in version 1.31.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@quike quike added the released label Sep 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Per-command controls for commands: groups — env/dir/silent overrides, failure policy, composition decision

1 participant