summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBen Hutchings <ben.hutchings@codethink.co.uk>2020-09-08 15:42:11 +0100
committerBen Hutchings <ben.hutchings@codethink.co.uk>2020-09-09 13:55:32 +0000
commit4702650752f8984ef15e340f5ea3d926ab1f23e1 (patch)
treee7e8aa830e202a0d8491e675ba1bdd090779a6a7 /README
parentc23c94afe9be0078a1c6114bd927d7f87cd0e2c7 (diff)
downloadlorries-4702650752f8984ef15e340f5ea3d926ab1f23e1.tar.gz
Add script to validate lorry files
Relates to #1.
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 16 insertions, 0 deletions
diff --git a/README b/README
index 97edebf..e7d568e 100644
--- a/README
+++ b/README
@@ -16,3 +16,19 @@ 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.