Skip to content

Commit be842f1

Browse files
committed
Add groupBy documentation
1 parent 27b792d commit be842f1

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/options.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,24 @@ The options are the same on specified above but in camelCase *e.g*:
3636
}
3737
```
3838

39+
### Group By
40+
41+
Via the configuration file you can have more complex grouping, using labels in a more creative way.
42+
`gren` will use the keys of the given Object as titles and group all the issues that contain one or more of the labels in the value Array. A bit complex to understand? Just see the example:
43+
44+
```json
45+
{
46+
"groupBy": {
47+
"Enhancements:": ["enhancement", "internal"],
48+
"Bug Fixes:": ["bug"]
49+
}
50+
}
51+
```
52+
53+
In this case `gren` will group all the issues labeled with `enhancement` and `internal` under the title _"Enhancements: "_ and all the ones with `bug` under the title _"Bug Fixes: "_.
54+
55+
### Extensions
56+
3957
The accepted file extensions are the following:
4058

4159
- `.grenrc`

0 commit comments

Comments
 (0)