mirrors/synapse
1
0
Fork 0
mirror of https://github.com/element-hq/synapse.git synced 2024-12-14 11:57:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Changelog entries only get merged if they have the same content and extension (#17399)

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

See
https://github.com/element-hq/synapse/pull/17301#discussion_r1665387218
This commit is contained in:
Eric Eastwood 2024-07-04 11:21:25 -05:00 committed by GitHub
parent 0c4f7a3d16
commit a9d2e40ea4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/17399.doc Normal file
View file

@ -0,0 +1 @@
Clarify that changelog content *and file extension* need to match in order for entries to merge.

6
docs/development/contributing_guide.md
View file

@ -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 > The security levels of Florbs are now validated when received
> via the `/federation/florb` endpoint. Contributed by Jane Matrix. > via the `/federation/florb` endpoint. Contributed by Jane Matrix.
If there are multiple pull requests involved in a single bugfix/feature/etc, If there are multiple pull requests involved in a single bugfix/feature/etc, then the
then the content for each `changelog.d` file should be the same. Towncrier will content for each `changelog.d` file and file extension should be the same. Towncrier
merge the matching files together into a single changelog entry when we come to will merge the matching files together into a single changelog entry when we come to
release. release.
### How do I know what to call the changelog file before I create the PR? ### How do I know what to call the changelog file before I create the PR?