Skip to content

Commit 9509dcf

Browse files
authored
docs: add notes about changelog-type configuration (#1867)
1 parent 123a598 commit 9509dcf

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

docs/customizing.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,16 @@ To configure multiple components on different paths, configure a
6363
## Changelog Types
6464

6565
A changelog type's job is to build the CHANGELOG notes given a list
66-
of parsed commits.
66+
of parsed commits. This generated content is used in the release pull request body
67+
and in release notes. By replacing the implementation, you can control how your
68+
release notes appear.
6769

6870
| Changelog Type | Description |
6971
| -------------- | ----------- |
7072
| `default` | Default CHANGELOG notes builder. Groups by commit type and links to pull requests and commits |
71-
| `github` | Uses the GitHub API to generate notes |
73+
| `github` | Uses the [GitHub API][release-notes-api] to generate notes |
74+
75+
[release-notes-api]: https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#generate-release-notes-content-for-a-release
7276

7377
### Adding additional changelog types
7478

0 commit comments

Comments
 (0)