Skip to content

Commit 3895bf2

Browse files
Update submodule documentation to only fetch needed files
1 parent e9e58aa commit 3895bf2

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

.gitmodules

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
[submodule "ckeditor5"]
22
path = ckeditor5
33
url = https://github.com/ckeditor/ckeditor5
4+
update = checkout
5+
shallow = true

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,5 +233,17 @@ To enter a development loop with hot reload support:
233233

234234
### Tests
235235

236-
Use `yarn test`, optionally with `--coverage`, `--watch`, or `--source-map`, to run tests.
236+
Run the below commands from the repo root directory to fetch files needed to run tests (you will only need to do this once):
237+
238+
```
239+
git submodule deinit ckeditor5
240+
rm -rf ckeditor5
241+
git clone --no-checkout --depth=1 --filter=blob:none https://github.com/ckeditor/ckeditor5
242+
rm -rf .git/modules/ckeditor5
243+
git submodule absorbgitdirs
244+
git -C ckeditor5 sparse-checkout set 'packages/ckeditor5-core/tests/_utils/**'
245+
git submodule update --init --force --checkout ckeditor5
246+
```
247+
248+
Then, use `yarn test`, optionally with `--coverage`, `--watch`, or `--source-map`, to run tests.
237249
You will need to have run `git submodule init` and `git submodule update` first.

0 commit comments

Comments
 (0)