Skip to content

docs(validation): state what --offline pins and what nothing pins #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LukasGold wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(validation): state what --offline pins and what nothing pins #149

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/how-to/validation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,18 @@ Exit code is 0 only when no check failed. Warnings do not fail a run.
| `--json` | Emit the report as JSON. |
| `--output FILE` | Write the JSON report to a file. |

### What `--offline` pins, and what nothing pins

The vendored meta-schemas are byte-exact per version, so a released version cannot change
meaning between runs. A document's `@context` carries no equivalent guarantee. `offline` is
false by default, which is what lets a cross-directory or genuinely remote `@context` resolve
at all, but it also means two runs over the same document can disagree if a context it reaches
for has moved in between.

`--offline` closes that gap by refusing to fetch, at the cost of failing on any reference that
is not already local or in the cache. That is why `make validate` passes it: the committed
fixtures are meant to give the same answer today and next year.

## Meta-schema versions

The meta-schemas belong to oold-schema. This package keeps a hand-curated copy of each released
Expand Down
Loading