docs(config): document that groups compose via flows, not nesting - #54
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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:
|
Owner
Author
|
🎉 This PR is included in version 1.31.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 whosecache:applies, whose gating runs, and what a cache hit on the inner group means for the outer one, while re-creating the orderingsteps:/run:already express.Adds a Groups do not nest section to
docs/CONFIG.mdstating 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 neithercommands: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.