summary refs log tree commit diff
diff options
context:
space:
mode:
authorEric Eastwood <eric.eastwood@beta.gouv.fr>2024-07-04 11:21:25 -0500
committerGitHub <noreply@github.com>2024-07-04 17:21:25 +0100
commita9d2e40ea4533e3f5fd369e817319e34f2a7dde9 (patch)
treecd81798f8909955c54cfc69cb609e03f9291e6eb
parentMerge branch 'master' into develop (diff)
downloadsynapse-a9d2e40ea4533e3f5fd369e817319e34f2a7dde9.tar.xz
Changelog entries only get merged if they have the same content and extension (#17399)
Changelog entries only get merged if they have the same content and
extension

See
https://github.com/element-hq/synapse/pull/17301#discussion_r1665387218
-rw-r--r--changelog.d/17399.doc1
-rw-r--r--docs/development/contributing_guide.md6
2 files changed, 4 insertions, 3 deletions
diff --git a/changelog.d/17399.doc b/changelog.d/17399.doc
new file mode 100644

index 0000000000..7a3fcf24c0 --- /dev/null +++ b/changelog.d/17399.doc
@@ -0,0 +1 @@ +Clarify that changelog content *and file extension* need to match in order for entries to merge. diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md
index 76c3e790cd..f079f61b48 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md
@@ -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?