Skip to content

Commit

Permalink
Add releaseNotes example to omit merge commits (#957)
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Apr 5, 2023
1 parent 30035e0 commit f7fb8bc
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/github-releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,17 @@ When the value is a string, it's executed as a shell script. Make sure it output
}
```

Another example using `--no-merges` to omit merge commits:

```json
{
"github": {
"release": true,
"releaseNotes": "git log --no-merges --pretty=format:\"* %s %h\" ${latestTag}...main"
}
}
```

When the value is a function, it's executed with a single `context` parameter that contains the plugin context. The
function can also be `async`. Make sure that it returns a string value. An example:

Expand All @@ -98,7 +109,7 @@ function can also be `async`. Make sure that it returns a string value. An examp
}
```

Use `--github.autoGenerate` to have GitHub auto-generate the release notes.
Use `--github.autoGenerate` to have GitHub auto-generate the release notes (does not work with `web: true`).

See [Changelog](./changelog.md) for more information about generating changelogs/release notes.

Expand Down

0 comments on commit f7fb8bc

Please sign in to comment.