Skip to content

Commit 0af7a04

Browse files
committed
Update readme file
1 parent a3a6631 commit 0af7a04

File tree

1 file changed

+2
-15
lines changed

1 file changed

+2
-15
lines changed

README.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Following the options for the module:
6262
- `--action=release|changelog` The **gren** action to run. Default: `release` _(see details below for changelog generator)_
6363
- `--tags=0.1.0|0.2.0,0.1.0` A specific tag or the range of tags to build the release notes from.
6464
- `--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`
6666
- `--time-wrap=latest|history` The release notes you want to include in the changelog. Default: `latest` _Only applicable to the `changelog` action_
6767
- `--changelog-filename=CHANGELOG.md` The name of the changelog file. Default: `CHANGELOG.md`
6868
- `--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*:
9191

9292
### Templates
9393

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:
9795

9896
```json
9997
{
100-
"...": "...",
10198
"template": {
10299
"commit": "- {{message}}",
103100
"issue": "- {{labels}} {{name}} {{link}}",
@@ -116,16 +113,6 @@ The default configuration is the following:
116113
}
117114
```
118115

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.*
120-
121-
```json
122-
{
123-
"template": {
124-
"issue": "- {{name}}"
125-
}
126-
}
127-
```
128-
129116
## Examples
130117

131118
The ways to use **gren** are various.

0 commit comments

Comments
 (0)