Skip to content

Commit 3f767e1

Browse files
unleashedwoile
authored andcommitted
docs(customization): add "parents" to the list of fields in Changes
1 parent 57ea95f commit 3f767e1

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/customization.md

+4
Original file line numberDiff line numberDiff line change
@@ -507,12 +507,16 @@ Each `Change` has the following fields:
507507
| scope | `str | None` | An optional scope |
508508
| message | `str` | The commit message body |
509509
| sha1 | `str` | The commit `sha1` |
510+
| parents | `list[str]` | The parent commit(s) `sha1`(s) |
510511
| author | `str` | The commit author name |
511512
| author_email | `str` | The commit author email |
512513

513514
!!! Note
514515
The field values depend on the customization class and/or the settings you provide
515516

517+
The `parents` field can be used to identify merge commits and generate a changelog based on those. Another use case
518+
is listing commits that belong to the same pull request.
519+
516520
When using another template (either provided by a plugin or by yourself), you can also pass extra template variables
517521
by:
518522

0 commit comments

Comments
 (0)