ProofShot — ビジュアル検証ワークフロー は何をしますか?
使用するタイミング
ProofShot を使用するのは、以下の後です。
- 新しい UI 機能やページを構築した後
- 既存の UI コンポーネントを修正した後
- ビジュアルバグを修正した後
- ユーザーの目に見える部分に影響を与える変更を行った後
ワークフロー(常にこの 3 つのステップに従ってください)
ステップ 1: セッションを開始する
proofshot start --description "これから検証する内容"
これにより開発サーバーが起動し、ヘッドレスブラウザが開き、録画が開始されます。 description に指定した説明は、人間が確認する証跡レポートに表示されます。
ステップ 2: ブラウザを操作してテストする
proofshot exec を使用して、ページの移動、操作、検証を行います。
proofshot exec snapshot -i # インタラクティブな要素を表示
proofshot exec open http://localhost:PORT/page # ページに移動
proofshot exec click @e3 # ボタンをクリック
proofshot exec fill @e2 "[email protected]" # フォームフィールドに入力
proofshot exec screenshot step-NAME.png # 重要な瞬間をキャプチャ
重要な瞬間にスクリーンショットを撮影します。これらがビジュアルの証拠になります。 スナップショットの出力を読んで、想定通りの表示が行われているか確認してください。
ステップ 3: 停止して証拠をまとめる
proofshot stop
録画を停止し、コンソールエラーとサーバーエラーを収集して、 動画、スクリーンショット、エラーレポートを含む SUMMARY.md を生成します。
ステップ 4(オプション): 証拠を PR に投稿する
proofshot pr # 現在のブランチから PR を自動検出
proofshot pr 42 # 特定の PR 番号を指定
スクリーンショットと動画を GitHub にアップロードし、PR にフォーマットされたコメントを投稿します。デフォルトでは、公式の GitHub Contents API を使用して proofshot-artifacts ブランチにアップロードします。GitHub の添付ファイル URL を特に使用したい場合は、--upload-provider github-web-attachments を使用してください。
ヒント
- 人間が何をテストしたかわかるように、必ず意味のある --description を含めてください。
- 重要なアクションの前 と 後の両方でスクリーンショットを撮影してください(例: フォーム送信前、リダイレクト後)。
- 検証中にエラーを見つけた場合は、修正してからワークフローを再実行してください。
- 停止した後、
proofshot prを使用して、証拠をプルリクエストに直接添付してください。