psboard-qaqc-postprocess/docs/README-ja.md

71 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2024-07-24 12:48:41 +09:00
# psb_qaqc
2024-07-25 13:40:03 +09:00
QAQC実施直後にmasterでログをまとめるときに使うコマンドのマニュアル。
## シフトでの使い方
### 1. masterのログをCSVに変換する
```
# psb-qaqc add-master-log <LOG FILE> <DATABASE CSV>
```
```sh
psb-qaqc add-master-log ./logs/20.log out_20.csv
```
### 2. 再試験にまわすボードを決める
TODO: 判断基準
masterのログまたはcsvを参照しながら再試験するかを判断し、
再試験するものはさっき作ったcsvファイルの右側の`false`を`true`に書き換える。
また、その右側にコメントを書き加える。
[CSVへの書き込みについて](#CSVへの書き込みについて)
### 3. Google sheetsにアップロードする
CSVをコピーして、[Google sheets](https://docs.google.com/spreadsheets/d/128qOseOy4QDotehYe4Wf2jj88tnwiXGVdR3NHrjcDYU/edit?pli=1&gid=408695746#gid=408695746)の一番下に加える。
*列をわける*のようなものを選択するとうまく貼れる。
### 4. CSVの後処理
アップロード済みである(編集しない)ことを明らかにするために、`log`ディレクトリに`_uploaded.csv`の名前にして移動させる。
2024-07-24 12:48:41 +09:00
## 機能
サブコマンドごとに機能がわかれている。
2024-07-25 13:40:03 +09:00
各コマンドで`--help`を渡せばヘルプがみれる。
2024-07-24 12:48:41 +09:00
### `add-master-log`
QAQC実施直後にMaster JATHub上で実行することでMasterでのログをCSVに書き加える。
2024-07-25 13:40:03 +09:00
```
# psb-qaqc add-master-log <LOG FILE> <DATABASE CSV>
```
2024-07-24 12:48:41 +09:00
```sh
2024-07-25 13:40:03 +09:00
psb-qaqc add-master-log ./logs/20.log out.csv
2024-07-24 12:48:41 +09:00
```
2024-07-25 13:40:03 +09:00
### `check-db`
2024-07-24 12:48:41 +09:00
CSVファイルのフォーマットが正常か確認する。
2024-07-25 13:40:03 +09:00
正常でない場合、0以外を返す。
2024-07-24 12:48:41 +09:00
```sh
psb-qaqc check-db out.csv
```
2024-07-25 13:40:03 +09:00
## CSVへの書き込みについて
CSVの一番最後の列にコメントを書き込めるようにしている。
以下コメントを書き込む際の注意点・推奨事項:
- `" "` で囲む
- `,`は書き込める
- `"`を使うときは`""`のように重ねてかく
- 一番うしろには`,`を書かない
*例*
```csv
,,"日本語も,かけます ""field"""
```
編集前にバックアップを作成することを推奨します。