You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+2-15Lines changed: 2 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ Following the options for the module:
62
62
-`--action=release|changelog` The **gren** action to run. Default: `release`_(see details below for changelog generator)_
63
63
-`--tags=0.1.0|0.2.0,0.1.0` A specific tag or the range of tags to build the release notes from.
64
64
-`--ignore-labels=wont_fix|wont_fix,duplicate` One or more labels to ignore in the output. Default: `false`_(it will still output the issue, just without the specified labels)_
65
-
-`--ignore-issues-with=wont_fix|wont_fix,duplicate` Ignore issues that contains one of the specified issues. Default: `false`
65
+
-`--ignore-issues-with=wont_fix|wont_fix,duplicate` Ignore issues that contains one of the specified labels. Default: `false`
66
66
-`--time-wrap=latest|history` The release notes you want to include in the changelog. Default: `latest`_Only applicable to the `changelog` action_
67
67
-`--changelog-filename=CHANGELOG.md` The name of the changelog file. Default: `CHANGELOG.md`
68
68
-`--data-source=issues|commits` The informations you want to use to build release notes. Default: `issues`
@@ -91,13 +91,10 @@ The options in the file would be camelCase *e.g*:
91
91
92
92
### Templates
93
93
94
-
With **gren** you can decide how you want to output the informations, using the templates.
95
-
96
-
The default configuration is the following:
94
+
You can configure the output of **gren** using templates. Set your own configuration inside the config file, which will be merged with the defaults, shown below:
97
95
98
96
```json
99
97
{
100
-
"...": "...",
101
98
"template": {
102
99
"commit": "- {{message}}",
103
100
"issue": "- {{labels}} {{name}} {{link}}",
@@ -116,16 +113,6 @@ The default configuration is the following:
116
113
}
117
114
```
118
115
119
-
To customise the templates you need to change the `.gren.json` config file. You only need to specify what you want to change *e.g.*
0 commit comments