本文へ移動

プライバシー ​

マシンの外に送るもの ​

  • ghusage が通信する相手は GitHub の API だけです。既定では https://api.github.com、GHUSAGE_API_URL / GHUSAGE_GRAPHQL_URL を設定した場合はそのエンドポイントです。リクエストはすべて読み取りで、ghusage が GitHub 上の何かを変更することはありません。
  • テレメトリーはありません。アクセス解析も、更新の確認もしません。
  • トークンは、設定した API のエンドポイントにだけ、Authorization ヘッダーに入れて送ります。ページ送りのリンクが別のホストを指している場合は拒否するので、トークンがほかの場所に転送されることはありません。
  • ターミナル UI でリンクを開く(o)と、https://github.com の URL をブラウザーに渡します。
  • --offline を指定すると、何も送りません。

ローカルに保存するもの ​

取得したデータは、データディレクトリにある SQLite のデータベース ghusage.db に保存します(同期とキャッシュを参照)。保存するのは、分析したアカウントについてのリポジトリ、プルリクエスト、Issue、コミット、レビュー、コメント、レビュースレッド、タイムラインイベント、CI の結果、コミットとプルリクエストの行数、カバレッジ、同期の履歴です。トークンで読めるプライベートリポジトリの名前、タイトル、メタデータが含まれることがあります。ghusage commit やターミナル UI で開いたコミットは、メッセージ、変更ファイル名、diff(変更されたファイルの中身)も保存し、次からオフラインでも表示できるようにします。

  • トークンをキャッシュ、ログ、出力に書き込むことは決してありません。エラーメッセージにも含めません。
  • キャッシュは普通のファイルで、ユーザーアカウントのファイル権限で守られています。macOS と Linux では、ghusage はデータディレクトリを自分だけが読める権限(0700)で作り、データベースとロックファイルを 0600 で作ります。自分で作ったディレクトリ(たとえば --data-dir で指定したもの)は、権限をそのまま保ちます。キャッシュは、仕事のデータを含むほかのファイルと同じように扱ってください。
  • ghusage cache clear は、キャッシュした GitHub のデータをすべて削除します(空のデータベースファイルは残ります)。データディレクトリを削除すると、すべてが消えます。
  • --no-cache を指定すると、取得したデータは 1 回のコマンドの間だけメモリーに置きます。

エクスポート ​

JSON、CSV、Markdown の出力は、人に渡したりどこかにコミットしたりすることが多いので、既定ではプライベートリポジトリと内部リポジトリの情報を隠します。リポジトリ名は <owner>/repo-<hash> になり(自分が所有していないリポジトリでは owner が private になります)、プルリクエストと Issue のタイトルは [private] になります。URL、ファイルのパス、ラベル名、以前のタイトル、CI のチェック名は削除します。数値は変わりません。

実際の名前、タイトル、URL を含めるには、--include-private を指定します。

次のものは隠しません。人のログイン(プライベートリポジトリのほかの参加者を含む)、GitHub の node ID、タイムスタンプ、件数です。エクスポートを公開する前に、中身を確認してください。

表形式の出力とターミナル UI には、実際の名前を表示します。表示されるのは自分自身だけだからです。

プライベートリポジトリを完全に除くには、--public-only を使います。プライベートリポジトリを取得も表示もしなくなります。

ターミナルでの安全性 ​

GitHub から来るテキスト(タイトル、ログイン、リポジトリ名、ラベル名、コミットメッセージ、ファイル名、diff、エラーメッセージ)は、表示する前に制御文字とエスケープシーケンスを取り除きます。そのため、GitHub 上の内容からターミナルのエスケープコードを送り込むことはできません。CSV のセルが =、+、-、@ のいずれかで始まる場合は、先頭に ' を付けて、スプレッドシートの数式インジェクションを防ぎます。