JOJ/JOJ3
24
5
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases Wiki Activity

Update JOJ3 Configuration Schema

manuel 2024-10-03 11:16:01 +08:00
parent 2b6c8df01e
commit b4105b7436
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
JOJ3-Configuration-Schema.md

@ -3,9 +3,11 @@
*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. *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.
Levels: Levels:
- repo: repository - repository: global repository config
- assignment: homework or project (no meta config needed at that level) - assignment: eg. homework or project (no meta config needed at that level)
- task: exercise or milestone - task: eg. exercise or milestone
JOJ configuration generator should read both repository and task `.toml` files and generate a single `conf.json` file located in the folder of the corresponding task.
## Commit message and course-joj repo tree ## Commit message and course-joj repo tree
@ -23,7 +25,7 @@ Scope usage:
## Repo level ## Repository level configuration
Teaching team info, eg. useful to check who triggered a grading. Teaching team info, eg. useful to check who triggered a grading.
@ -50,7 +52,7 @@ immutable.files = [".gitignore", ".gitattributes", ".gitea/workflows/push.yaml"]
immutable.hash = ["fafssafds7","kjklhk5hk345", "nvnfjuysf653214"] # hash of readonly files immutable.hash = ["fafssafds7","kjklhk5hk345", "nvnfjuysf653214"] # hash of readonly files
``` ```
## Task level ## Task level configuration
Basic idea: Basic idea:
- list all stages that are to be run - list all stages that are to be run