JOJ/JOJ3-config-generator
27
1
Fork 0
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity
A CLI tool that generates configuration files for JOJ3.
210 Commits 2 Branches 0 Tags 1 MiB
Python 100%
f26a6e8f90
Go to file
王韵晨520370910012 f26a6e8f90
Some checks failed
build / build (push) Failing after 2m48s
Details
build / trigger-build-image (push) Has been skipped
Details
build / build (pull_request) Failing after 2m2s
Details
build / trigger-build-image (pull_request) Has been skipped
Details
feat: add whitelist character support in repo toml 
This commit introduces a new key, `health-check.whitelisted-chars` for
repo.toml. It allows TAs to configure repo-wide allowed non ASCII chars
for the repo-health-checker binary. It results in a new command line
switch, `-whitelisted-chars=X,Y,Z`, in the generated task.json.
2026-04-07 16:14:07 -07:00
.gitea/workflows fix: pdm run test 2025-06-20 17:18:00 -04:00
joj3_config_generator feat: add whitelist character support in repo toml 2026-04-07 16:14:07 -07:00
tests feat: add whitelist character support in repo toml 2026-04-07 16:14:07 -07:00
.editorconfig chore: simple .editorconfig 2024-10-03 22:58:24 -04:00
.gitignore chore: add setuptools-scm with version 2025-06-02 20:22:41 -04:00
.pre-commit-config.yaml feat: more strict models 2025-09-17 14:26:09 -07:00
LICENSE chore: cleanup & setup pdm 2024-10-17 18:28:01 -04:00
pdm.lock feat: natural sort cases 2025-11-21 20:12:27 -08:00
pyproject.toml feat: natural sort cases 2025-11-21 20:12:27 -08:00
README.md docs: add force reinstall option 2025-06-01 06:59:58 -04:00

README.md

JOJ3-config-generator

Codacy Badge Codacy Badge

Getting Started

For users

  1. Install Python>=3.9 and pip
  2. (Optional) Create a virtual environment, check here.
  3. Install/Upgrade the project by pip install --force-reinstall --upgrade git+ssh://git@focs.ji.sjtu.edu.cn:2222/JOJ/JOJ3-config-generator.git
  4. Run it by joj3-config-generator --help

For developers

  1. Clone this repo by git clone ssh://git@focs.ji.sjtu.edu.cn:2222/JOJ/JOJ3-config-generator.git
  2. Install Python>=3.9 and PDM
  3. Change dir to the repo, cd JOJ3-config-generator
  4. Install deps by pdm install && pdm run pre-commit install
  5. Run the cli app by pdm run app --help
  6. Check other commands or scripts with pdm run --list

How to use?

  • joj3-config-generator convert function is now supported, currently support one argument as input, it indicates the convert root
    • default value on the server can be given as /home/tt/.config/joj
    • NOTE: the user should ensure that the ideal repo.toml file is in the sub-directory of the convert root
    • the intended immutable files should be placed at a sub-directory named immutable_files at same position as the repo.toml file
$ tree .
.
|- immutable_files
| |-- push.yaml
| |-- release.yaml
|-- repo.toml
  • sample command on the server
joj3-config-generator convert /home/tt/.config/joj