You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
README: describe the minimal setup required to pass the test suite
When trying to enhance the test suite, it can be a bit tricky to figure
out what sparse-checkout definition to use. The alternative would be to
build the entire site, which would be prohibitively slow for an
efficient development cycle.
Therefore, let's document that (quite involved, I am afraid!) sparse
checkout definition for the minimum set of files required to build the
site and run the test suite.
Signed-off-by: Johannes Schindelin <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+46Lines changed: 46 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,6 +105,52 @@ Note that running Pagefind will make the process about 7 times slower, and the s
105
105
106
106
Believe it or not, https://git-scm.com/ has its own test suite. It uses [Playwright](https://playwright.dev/) to perform a couple of tests that verify that the site "looks right". These tests live in `tests/` and are configured via `playwright.config.js`.
107
107
108
+
> [!NOTE]
109
+
> Building the site, letting Pagefind generate the search index, and then running the test suite can be quite time consuming. To accelerate the development cycle, it is _highly_ recommended to use a sparse checkout instead of a full clone. The minimal sparse checkout required to run the test suite can be configured like this:
110
+
>
111
+
> ```console
112
+
> $ git config set --worktree core.sparseCheckoutCone false
113
+
> $ git config set --worktree core.sparseCheckout true
0 commit comments