75 lines
2.4 KiB
Markdown
75 lines
2.4 KiB
Markdown
|
# Kontr Pushee
|
||
|
|
|
||
|
|
Tool that uploads Kontr submissions to gitlab repo and creates MRs so it's easier to review.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```
|
||
|
|
pushee <command>
|
||
|
|
|
||
|
|
Commands:
|
||
|
|
mrs Fetch files and create merge requests for them
|
||
|
|
update-assignees Update assignees on MRs
|
||
|
|
comments Fetch all comments on MRs
|
||
|
|
merge Merge all MRs
|
||
|
|
test Debugging function
|
||
|
|
```
|
||
|
|
|
||
|
|
## Dependencies
|
||
|
|
|
||
|
|
- [`ogr`](https://github.com/packit-service/ogr)
|
||
|
|
- `requests`
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
Uses config from `~/.pushee.json` and `GITLAB_TOKEN` from environment variables (used for accessing Gitlab's API).
|
||
|
|
|
||
|
|
### Example config
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"project_namespace": "xfocko",
|
||
|
|
"project_name": "2020-pb071-reviews",
|
||
|
|
"reviewer": "xfocko",
|
||
|
|
"homework": "hw04",
|
||
|
|
"homeworks": {
|
||
|
|
"hw03": {
|
||
|
|
"deadline": "2020_0426_020000",
|
||
|
|
"submissions": [
|
||
|
|
"xlogin_YYYY_MMDD_HHMMSS"
|
||
|
|
],
|
||
|
|
"correction": false,
|
||
|
|
"files": [
|
||
|
|
"cpu.h",
|
||
|
|
"cpu.c"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"hw04": {
|
||
|
|
"deadline": "2020_0507_235959",
|
||
|
|
"mbox_path": "~/hw04.mbox",
|
||
|
|
"correction": false,
|
||
|
|
"files": [
|
||
|
|
"main.c"
|
||
|
|
],
|
||
|
|
"prefix": "master-nanecisto/naostro"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### Description
|
||
|
|
|
||
|
|
- `project_namespace` - specifies project namespace (username) where are files uploaded and MRs created
|
||
|
|
- `project_name` - project name
|
||
|
|
- `reviewer` - login of reviewer, allows filtering out mails for colleagues
|
||
|
|
- `homework` - specifies which homework is being processed
|
||
|
|
- homework format (element of `homeworks`):
|
||
|
|
- `deadline` - deadline of homework formatted the same way as submissions from Kontr
|
||
|
|
- submissions to review (*one* of):
|
||
|
|
- `submissions` - list of submissions to be reviewed
|
||
|
|
- `mbox_path` - path to exported mails in mbox format
|
||
|
|
mails are parsed, submissions after deadline are ignored, chooses submission with highest points achieved
|
||
|
|
also leaves spaces for correction if needed
|
||
|
|
- `correction` - used for IB111, deadline specifies "timestamp" of submitting review to IS, from that date is calculated deadline of corrected homework
|
||
|
|
- `files` - list of files that are reviewed
|
||
|
|
- `prefix` - path from submission directory to the directory that *always* contains source files
|