JOJ/JOJ3-config-generator
27
1
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity
18df2ef1c0
JOJ3-config-generator/README.md
李衍志523370910113 18df2ef1c0
All checks were successful
build / build (push) Successful in 2m18s
Details
feat: support convert (#10) 
- basic generation of json files
  - supported parsers:
    - healthcheck
    - result-detail
    - result-status
    - file
    - log
    - dummy
    - keyword (keyword, clangtidy, cppcheck, cpplint)
    - diff
- `convert` functions is mature, tested in engr151-24fa last two homeworks and engr151-24fa p3
- teapot and healthcheck should be up to date

Co-authored-by: Boming Zhang <bomingzh@sjtu.edu.cn>
Reviewed-on: #10
Reviewed-by: Boming Zhang <bomingzh@sjtu.edu.cn>
Co-authored-by: jon-lee <jon-lee@sjtu.edu.cn>
Co-committed-by: jon-lee <jon-lee@sjtu.edu.cn>
2025-03-05 03:23:52 -05:00

1.4 KiB
Raw Blame History

JOJ3-config-generator

Getting Started

For users

  1. Install Python>=3.9 and pip
  2. Install the project by pip install git+ssh://git@focs.ji.sjtu.edu.cn:2222/JOJ/JOJ3-config-generator.git
  3. 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