From 6948ca93b0e71bd1522e175df806cb3fbcf63ffa Mon Sep 17 00:00:00 2001 From: manuel Date: Wed, 2 Oct 2024 16:24:22 +0800 Subject: [PATCH] Update JOJ3 Configuration Schema --- JOJ3-Configuration-Schema.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/JOJ3-Configuration-Schema.md b/JOJ3-Configuration-Schema.md index a1758c9..fe8bf14 100644 --- a/JOJ3-Configuration-Schema.md +++ b/JOJ3-Configuration-Schema.md @@ -1,8 +1,21 @@ # Basic meta config file specs -*Goals:* simple configuration files, which can easily be manually edited by TAs. These files is then parsed by joj-config-generation script to generate final internal `json` configurations files. +*Goals:* simple configuration files, which can easily be manually edited by TAs. These files are then parsed by joj-config-generation script to generate final internal `json` configurations files and joj3 to find the `json` config files. +## Repo level +Teaching team info, eg. useful to check who triggered a grading. + +It should never be possible to disable health check. + +Health check configuration: +- required files (readme, changelog) +- git whitelist (allowed files) +- git local-whitelist (list of "self-allowed" files $\to$ use with care) +- immutable files (gitignore, workflows) +- repo size limit + +## Task level ```toml stages = [ "compile", "code_quality", "joj" ]