From 73660e4a6f4ba9bba357b4192dfc286c6b21520e Mon Sep 17 00:00:00 2001 From: Kegan Dougal <7190048+kegsay@users.noreply.github.com> Date: Tue, 20 Feb 2024 16:49:20 +0000 Subject: [PATCH 1/3] Better complement docs --- docker/complement/README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docker/complement/README.md b/docker/complement/README.md index 62682219e84..c64a2f953f6 100644 --- a/docker/complement/README.md +++ b/docker/complement/README.md @@ -30,3 +30,14 @@ Consult `scripts-dev/complement.sh` in the repository root for a real example. [complement]: https://github.com/matrix-org/complement [complementEnv]: https://github.com/matrix-org/complement/pull/382 + +## How to modify homeserver.yaml for Complement tests + +It's common for MSCs to be gated behind a feature flag like this: +```yaml +experimental_features: + faster_joins: true +``` +To modify this for the Complement image, modify `./confg/workers-shared-extra.yaml.j2`. Despite the name, +this will affect non-worker mode as well. Remember to _rebuild_ the image (so don't use `-e` if using +`complement.sh`). From fed00737b0241ed92b1a66f1baa121278db2127b Mon Sep 17 00:00:00 2001 From: Kegan Dougal <7190048+kegsay@users.noreply.github.com> Date: Tue, 20 Feb 2024 16:50:31 +0000 Subject: [PATCH 2/3] Changelog --- changelog.d/16946.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/16946.doc diff --git a/changelog.d/16946.doc b/changelog.d/16946.doc new file mode 100644 index 00000000000..8037a654500 --- /dev/null +++ b/changelog.d/16946.doc @@ -0,0 +1 @@ +Improve the documentation around running Complement tests with new configuration parameters. \ No newline at end of file From 96c706e77949d8a8b1034e44607069b99268eeec Mon Sep 17 00:00:00 2001 From: Kegan Dougal <7190048+kegsay@users.noreply.github.com> Date: Tue, 20 Feb 2024 16:51:21 +0000 Subject: [PATCH 3/3] Typo --- docker/complement/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker/complement/README.md b/docker/complement/README.md index c64a2f953f6..1ce84128184 100644 --- a/docker/complement/README.md +++ b/docker/complement/README.md @@ -38,6 +38,6 @@ It's common for MSCs to be gated behind a feature flag like this: experimental_features: faster_joins: true ``` -To modify this for the Complement image, modify `./confg/workers-shared-extra.yaml.j2`. Despite the name, +To modify this for the Complement image, modify `./conf/workers-shared-extra.yaml.j2`. Despite the name, this will affect non-worker mode as well. Remember to _rebuild_ the image (so don't use `-e` if using `complement.sh`).