Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
joaander committed Aug 20, 2024
1 parent d9d7abe commit 43df2b3
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions doc/src/workflow/action/group.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,18 @@ groups of directories included in a given action.
## include

`action.group.include`: **array** of **tables** - Define a set of selectors, *any* of
which may be true for a directory to be included in this group.
which may be `true` for a directory to be included in this group.

Each selector is a **table** with only one of the following keys:
* `condition`: An array of three elements: The *JSON pointer*, *the operator*, and the
*operand*. The [JSON pointer](../../guide/concepts/json-pointers.md) references a
specific portion of the directory's value. The operator may be `"<"`, `"<="`,
`"=="`, `">="`, or `">"`.
* `all`: Array of conditions (see above). All conditions must be true for this selector
to be true.
`"=="`, `">="`, or `">"`. Both operands **must** have the same data type. The element
referenced by each JSON pointer must be present in the value of **every** directory.
* `all`: Array of conditions (see above). All conditions must be `true` for this selector
to be `true`. `all` is evaluated with short-circuit logic. When an element in `all`
evaluates to `false`, the JSON pointers in the remaining elements are not evaluated
and are not required to be present.

For example, select all directories where a value is in the given range:
```toml
Expand All @@ -54,10 +57,7 @@ Compare by array:
condition = ["/array", "==", [1, "string", 14.0]
```

Both operands **must** have the same data type. The element referenced by JSON pointer
must be present in the value of **every** directory.

When you omit `include`, **row** includes **all** directories in the workspace.

> Note: **Row** compares arrays *lexicographically*.

Expand All @@ -66,6 +66,8 @@ JSON Objects (also known as maps or dictionaries) are not comparable. You must u
pointers to specific keys in objects.
</div>

When you omit `include`, **row** includes **all** directories in the workspace.

## sort_by

`action.group.sort_by`: **array** of **strings** - An array of
Expand Down Expand Up @@ -122,7 +124,7 @@ would split into the groups:

When omitted, there is no maximum group size.

When `maximum_size` is set **and** `split_by_sort_key` is `true`, **row** first splits
When both `maximum_size` **and** `split_by_sort_key` are `true`, **row** first splits
by the sort key, then splits the resulting groups according to `maximum_size`.

## submit_whole
Expand Down

0 comments on commit 43df2b3

Please sign in to comment.