Update JOJ3 Configuration Schema

manuel 2024-10-02 16:24:22 +08:00
parent 928ac4bd60
commit 6948ca93b0

@ -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" ]