From 0c55c76da807c8ca0c37b7394594d3757ffab8a6 Mon Sep 17 00:00:00 2001 From: kegsay <7190048+kegsay@users.noreply.github.com> Date: Tue, 20 Feb 2024 17:14:50 +0000 Subject: [PATCH] Better complement docs (#16946) --- changelog.d/16946.doc | 1 + docker/complement/README.md | 11 +++++++++++ 2 files changed, 12 insertions(+) create mode 100644 changelog.d/16946.doc diff --git a/changelog.d/16946.doc b/changelog.d/16946.doc new file mode 100644 index 000000000..8037a6545 --- /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 diff --git a/docker/complement/README.md b/docker/complement/README.md index 62682219e..1ce841281 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 `./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`).