Skip to content

Commit

Permalink
Changelog entries only get merged if they have the same content and e…
Browse files Browse the repository at this point in the history
…xtension (#17399)

Changelog entries only get merged if they have the same content and
extension

See
#17301 (comment)
  • Loading branch information
MadLittleMods authored Jul 4, 2024
1 parent 0c4f7a3 commit a9d2e40
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions changelog.d/17399.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify that changelog content *and file extension* need to match in order for entries to merge.
6 changes: 3 additions & 3 deletions docs/development/contributing_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -449,9 +449,9 @@ For example, a fix in PR #1234 would have its changelog entry in
> The security levels of Florbs are now validated when received
> via the `/federation/florb` endpoint. Contributed by Jane Matrix.

If there are multiple pull requests involved in a single bugfix/feature/etc,
then the content for each `changelog.d` file should be the same. Towncrier will
merge the matching files together into a single changelog entry when we come to
If there are multiple pull requests involved in a single bugfix/feature/etc, then the
content for each `changelog.d` file and file extension should be the same. Towncrier
will merge the matching files together into a single changelog entry when we come to
release.

### How do I know what to call the changelog file before I create the PR?
Expand Down

0 comments on commit a9d2e40

Please sign in to comment.