summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
index 97edebf..713ef33 100644
--- a/README
+++ b/README
@@ -16,3 +16,23 @@ add any additional configuration to this repository.
Remember, the Lorry tool is not permitted to manage repositories inside your
prefix which is baserock.
+Validation
+----------
+
+Run `scripts/validate-lorries` to check the `.lorry` files. This will
+report:
+
+* Invalid YAML/JSON syntax
+* Wrong data types
+* Duplicate repository names
+* Missing required keys
+* Unexpected keys
+* Invalid values
+
+The syntax and duplicate name checks are applied even to disabled
+`.lorry` files, because reusing a repository name for a different
+upstream type generally won't work.
+
+Run `scripts/check-lorry-urls` to check that the upstream repositories
+and files referred to by the active `.lorry` files exist. This will
+take several minutes.