deploy: ffe2464836

develop/development/contributing_guide.html

@@ -347,6 +347,13 @@ Here is how to run your local Synapse checkout against your local Complement che
 <li>Passing <code>POSTGRES=1</code> as an environment variable to use the Postgres database instead.</li>
 <li>Passing <code>WORKERS=1</code> as an environment variable to use a workerised setup instead. This option implies the use of Postgres.</li>
 </ul>
+<h3 id="prettier-formatting-with-gotestfmt"><a class="header" href="#prettier-formatting-with-gotestfmt">Prettier formatting with <code>gotestfmt</code></a></h3>
+<p>If you want to format the output of the tests the same way as it looks in CI,
+install <a href="https://github.com/haveyoudebuggedit/gotestfmt">gotestfmt</a>.</p>
+<p>You can then use this incantation to format the tests appropriately:</p>
+<pre><code class="language-sh">COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -json | gotestfmt -hide successful-tests
+</code></pre>
+<p>(Remove <code>-hide successful-tests</code> if you don't want to hide successful tests.)</p>
 <h3 id="access-database-for-homeserver-after-complement-test-runs"><a class="header" href="#access-database-for-homeserver-after-complement-test-runs">Access database for homeserver after Complement test runs.</a></h3>
 <p>If you're curious what the database looks like after you run some tests, here are some steps to get you going in Synapse:</p>
 <ol>

develop/print.html

@@ -14023,6 +14023,13 @@ Here is how to run your local Synapse checkout against your local Complement che
 <li>Passing <code>POSTGRES=1</code> as an environment variable to use the Postgres database instead.</li>
 <li>Passing <code>WORKERS=1</code> as an environment variable to use a workerised setup instead. This option implies the use of Postgres.</li>
 </ul>
+<h3 id="prettier-formatting-with-gotestfmt"><a class="header" href="#prettier-formatting-with-gotestfmt">Prettier formatting with <code>gotestfmt</code></a></h3>
+<p>If you want to format the output of the tests the same way as it looks in CI,
+install <a href="https://github.com/haveyoudebuggedit/gotestfmt">gotestfmt</a>.</p>
+<p>You can then use this incantation to format the tests appropriately:</p>
+<pre><code class="language-sh">COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -json | gotestfmt -hide successful-tests
+</code></pre>
+<p>(Remove <code>-hide successful-tests</code> if you don't want to hide successful tests.)</p>
 <h3 id="access-database-for-homeserver-after-complement-test-runs"><a class="header" href="#access-database-for-homeserver-after-complement-test-runs">Access database for homeserver after Complement test runs.</a></h3>
 <p>If you're curious what the database looks like after you run some tests, here are some steps to get you going in Synapse:</p>
 <ol>