mpabi
195 lines
4.1 KiB
Markdown
195 lines
4.1 KiB
Markdown
# RV Launcher
|
|
|
|
Launcher do workspace `rv`.
|
|
|
|
- `workspace.json` trzyma sciezki workspace i tools
|
|
- `workspace.py` listuje serie i karty
|
|
- szczegolowy opis przelacznikow skryptu jest w `doc/usage.md`
|
|
|
|
## Przygotowanie katalogu
|
|
|
|
Docelowy katalog:
|
|
|
|
```bash
|
|
~/dev/workspace/rv/tools/rv-launcher
|
|
```
|
|
|
|
Bootstrap bez `git clone`:
|
|
|
|
```bash
|
|
mkdir -p ~/dev/workspace/rv/tools
|
|
mkdir -p ~/dev/workspace/rv/tools/rv-launcher
|
|
cd ~/dev/workspace/rv/tools/rv-launcher
|
|
git init
|
|
```
|
|
|
|
## Autoryzacja
|
|
|
|
Masz dwie drogi.
|
|
|
|
### Droga 1: remote `r1` z tokenem w URL
|
|
|
|
To jest wariant dydaktyczny, jesli uczen ma cwiczyc reczne dodawanie remota z
|
|
tokenem do konkretnego zdalnego endpointu.
|
|
|
|
Przyklad:
|
|
|
|
```bash
|
|
git remote add r1 http://u1:TOKEN@77.90.8.171:3001/edu-tools/rv-launcher.git
|
|
git fetch r1 main
|
|
git switch --track -c main r1/main
|
|
```
|
|
|
|
### Droga 2: lokalny `tokens/gitea_tokens.json`
|
|
|
|
To jest wariant alternatywny, wygodniejszy wtedy, gdy launcher ma sam wykonywac
|
|
`clone`, `fetch` i `push`, albo gdy uzytkownik po zajeciach chce pracowac juz na
|
|
wlasnych repo bez wpisywania tokena do kazdego remota.
|
|
|
|
Przed operacjami wymagajacymi autoryzacji dodaj lokalny token do:
|
|
|
|
```bash
|
|
~/dev/workspace/rv/tokens/gitea_tokens.json
|
|
```
|
|
|
|
Minimalny format:
|
|
|
|
```json
|
|
{
|
|
"users": {
|
|
"u1": {
|
|
"tokens": {
|
|
"t1": "TU_WSTAW_TOKEN"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
Plik powinien byc lokalny, niewersjonowany i miec prawa `600`.
|
|
|
|
Przyklad:
|
|
|
|
```bash
|
|
mkdir -p ~/dev/workspace/rv/tokens
|
|
chmod 700 ~/dev/workspace/rv/tokens
|
|
chmod 600 ~/dev/workspace/rv/tokens/gitea_tokens.json
|
|
```
|
|
|
|
Jesli token jest trzymany tylko w `tokens/gitea_tokens.json`, remote `r1` moze
|
|
byc zapisany bez sekretu:
|
|
|
|
```bash
|
|
git remote add r1 http://77.90.8.171:3001/edu-tools/rv-launcher.git
|
|
```
|
|
|
|
## Fetch i switch
|
|
|
|
Domyslna galaz launchera to `main`.
|
|
|
|
Wariant preferowany przez `r1`:
|
|
|
|
```bash
|
|
git fetch r1 main
|
|
git switch --track -c main r1/main
|
|
git pull --ff-only r1 main
|
|
```
|
|
|
|
Jesli repo bylo sklonowane klasycznie i pracujesz przez `origin`, odpowiednikiem
|
|
jest:
|
|
|
|
```bash
|
|
git fetch origin main
|
|
git switch main
|
|
git pull --ff-only origin main
|
|
```
|
|
|
|
Jesli chcesz wejsc na inna galaz, na przyklad `feat/x`, uzyj:
|
|
|
|
```bash
|
|
git fetch r1 feat/x
|
|
git switch --track -c feat/x r1/feat/x
|
|
```
|
|
|
|
Wariant przez `origin`:
|
|
|
|
```bash
|
|
git fetch origin feat/x
|
|
git switch --track -c feat/x origin/feat/x
|
|
```
|
|
|
|
## Repo odpowiedzi kart pracy
|
|
|
|
Model pracy kart jest taki:
|
|
|
|
- `r1` wskazuje repo z materialem z `edu-inf`
|
|
- `a1` wskazuje wspolne repo odpowiedzi w `zsl-inf`
|
|
- kazdy uczen wysyla swoja prace na branch o nazwie swojego nicku
|
|
|
|
Repo odpowiedzi nie zawiera nicku w nazwie. Launcher buduje je w formacie:
|
|
|
|
```text
|
|
zsl-inf/<repo_z_edu-inf>-<klasa>-<data>
|
|
```
|
|
|
|
Przyklad:
|
|
|
|
```text
|
|
zsl-inf/lab-rv32i-strlen-bss-data-stack-4i-2026-04-26
|
|
```
|
|
|
|
Przyklad planu dla ucznia `u1`:
|
|
|
|
```bash
|
|
python3 workspace.py submission inf 03 --class 4i --nick u1
|
|
```
|
|
|
|
Przyklad konfiguracji remote'ow w repo karty:
|
|
|
|
```bash
|
|
python3 workspace.py submission inf 03 --class 4i --nick u1 --apply
|
|
```
|
|
|
|
Launcher wtedy:
|
|
|
|
- czyta URL zrodlowego repo z `origin` aktualnej karty i ustawia go jako `r1`
|
|
- bierze basename tego repo z `edu-inf` i z niego buduje nazwe repo odpowiedzi
|
|
- wylicza repo odpowiedzi w `zsl-inf` i ustawia je jako `a1`
|
|
- proponuje branch ucznia, na przyklad `u1`
|
|
|
|
Typowy wynik to:
|
|
|
|
```text
|
|
source_repo edu-inf/lab-rv32i-strlen-bss-data-stack
|
|
source_remote r1
|
|
answer_remote a1
|
|
answer_repo zsl-inf/lab-rv32i-strlen-bss-data-stack-4i-2026-04-26
|
|
student_branch u1
|
|
```
|
|
|
|
## Wariant alternatywny: `git clone`
|
|
|
|
Jesli celem nie jest cwiczenie `remote add` i `fetch`, mozna tez uzyc:
|
|
|
|
```bash
|
|
mkdir -p ~/dev/workspace/rv/tools
|
|
cd ~/dev/workspace/rv/tools
|
|
git clone http://77.90.8.171:3001/edu-tools/rv-launcher.git
|
|
cd rv-launcher
|
|
```
|
|
|
|
## Podstawowe komendy
|
|
|
|
Przyklady:
|
|
|
|
```bash
|
|
python3 workspace.py show-config
|
|
python3 workspace.py list-series
|
|
python3 workspace.py list-cards inf
|
|
python3 workspace.py submission inf 03 --class 4i --nick u1
|
|
python3 workspace.py tmux-container inf 03 --dry-run
|
|
python3 workspace.py tmux-container inf 03 --session rv-inf03 --attach
|
|
```
|
|
|
|
Skrypt nie trzyma listy kart w JSON-ie. Czyta `series/*/*` z `series_root`.
|