Skip to content

Commit 95462c3

Browse files
committed
Bring back normalization and explain submodules in README
1 parent 6dc3cb5 commit 95462c3

File tree

3 files changed

+24
-2
lines changed

3 files changed

+24
-2
lines changed

.github/workflows/main.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ jobs:
6767
run: |
6868
python tests/runtests.py ./specifications/json-ld-api/tests -l ${{ matrix.loader }}
6969
python tests/runtests.py ./specifications/json-ld-framing/tests -l ${{ matrix.loader }}
70+
python tests/runtests.py ./specifications/normalization/tests -l ${{ matrix.loader }}
7071
env:
7172
LOADER: ${{ matrix.loader }}
7273
#coverage:

.gitmodules

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@
44
[submodule "specifications/json-ld-framing"]
55
path = specifications/json-ld-framing
66
url = https://github.com/w3c/json-ld-framing.git
7+
[submodule "specifications/normalization"]
8+
path = specifications/normalization
9+
url = https://github.com/json-ld/normalization.git

README.rst

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,15 +190,33 @@ Tests
190190
This library includes a sample testing utility which may be used to verify
191191
that changes to the processor maintain the correct output.
192192

193-
To run the sample tests you will need to get the test suite files by cloning
193+
To run the sample tests you will need to get the test suite files, which by default, are stored in the `specifications/` folder.
194+
The test suites can be obtained by either using git submodules or by cloning them manually.
195+
196+
## Using git submodules
197+
198+
The test suites are included as git submodules to ensure versions are in sync. When cloning the repository, use the ``--recurse-submodules`` flag to
199+
automatically clone the submodules.
200+
If you have cloned the repository without the submodules, you can initialize them with the following commands:
201+
202+
.. code-block:: bash
203+
204+
git submodule init
205+
git submodule update
206+
207+
## Cloning manually
208+
209+
You can also avoid using git submodules by manually cloning
194210
the ``json-ld-api``, ``json-ld-framing``, and ``normalization`` repositories
195211
hosted on GitHub:
196212

197213
- https://github.com/w3c/json-ld-api
198214
- https://github.com/w3c/json-ld-framing
199215
- https://github.com/json-ld/normalization
200216

201-
If the suites repositories are available as sibling directories of the PyLD
217+
## Running the tests
218+
219+
If the suites repositories are available in the `specifications/` folder of the PyLD
202220
source directory, then all the tests can be run with the following:
203221

204222
.. code-block:: bash

0 commit comments

Comments
 (0)