李衍志523370910113
9213e57ca3
All checks were successful
build / build (push) Successful in 2m32s
## What I have done:
- 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
## TODO
- update all new comming parsers in future.
@bomingzh Could you please help me do a code review first then I shall fix all things and rebase? I checked the source code of JOJ3 currently, and find we have more parsers, such as plugin and tierscore, I haven''t added them yet, and some of the keys might have changed such as clang-tidy, can you help me take a look if current version is still up to date? I ll redo the fix tomorrow
Co-authored-by: Boming Zhang <bomingzh@sjtu.edu.cn>
Reviewed-on: #10
Reviewed-by: 张泊明518370910136 <bomingzh@sjtu.edu.cn>
Co-authored-by: jon-lee <jon-lee@sjtu.edu.cn>
Co-committed-by: jon-lee <jon-lee@sjtu.edu.cn>
41 lines
1.4 KiB
Markdown
41 lines
1.4 KiB
Markdown
# JOJ3-config-generator
|
|
|
|
## Getting Started
|
|
|
|
### For users
|
|
|
|
1. Install [Python>=3.9](https://www.python.org/) and [pip](https://pip.pypa.io/)
|
|
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](https://www.python.org/) and [PDM](https://pdm-project.org/)
|
|
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
|
|
|
|
```shell
|
|
$ tree .
|
|
.
|
|
|- immutable_files
|
|
| |-- push.yaml
|
|
| |-- release.yaml
|
|
|-- repo.toml
|
|
```
|
|
|
|
- sample command on the server
|
|
|
|
```shell
|
|
joj3-config-generator convert /home/tt/.config/joj
|
|
```
|