Monster Orange はじめる

Monster Orange Den

私たちの GitHub App

インストールを担当する方(多くは GitHub organization のオーナー)向けのページです。各 App が求める権限とその理由、決してしないこと、削除の方法を App ごとに載せています。

Monster Orange Den

自分の Den に GitHub でサインインし、自分の名前でフィードバックを送れます。

あなたのコンピューターで動く Den に、どのブラウザからでも GitHub アカウントでサインインできます。パスワードは要りません。Den から送るフィードバックを、あなたの名前で GitHub に登録することもできます。鍵やシークレットは持たず、あなたのコードに手を加えることはありません。

権限

権限アクセス理由
Issues読み取りと書き込みDen から送ったフィードバックを、あなたの名前で issue(またはそのコメント)として登録するため。
Metadata読み取りGitHub がすべての App に求めるもの。

アカウントの権限はありません。Webhook やイベントも使いません。

決してしないこと

  • コードを読んだり、変更したり、push したりしません。
  • GitHub のトークンを保存しません。サインインや報告は毎回 GitHub 自身のページで承認され、一度だけ使って破棄します。
  • クライアントシークレットも秘密鍵も持ちません(Den はどちらも使いません)。
  • Den のオーナー以外は、その Den にサインインできません。

インストールと削除

Den で無効にする
web.github_client_id: "" を設定します。以後は使い捨てのコードかリンクでサインインします。
GitHub で取り消す
Settings › Applications › Authorized GitHub Apps › Monster Orange Den › Revoke。

Den について

Monster Orange CI runners

リポジトリの CI ジョブを、チーム自身のテストマシンで実行します。1 つのランナーで 1 ジョブを処理し、終わったら削除します。

チームが所有するテストマシンで、短命なセルフホストの GitHub Actions ランナーを起動します。対象は利用を選んだリポジトリだけです。各ランナーは 1 つのジョブを処理して削除されます。マシンが使用中、一時停止中、または電源が切れているときは、ジョブは GitHub のランナーに戻ります。シークレットは持たず、コードを変更することもありません。

権限

権限アクセス理由
Self-hosted runners (organization)読み取りと書き込み1 つのジョブのためにランナーを登録し、ランナーを一覧し、なくなったものを削除し、リポジトリごとに 1 つのランナーグループ(そのリポジトリだけが使えるもの)を保つため。
Actions読み取りと書き込み待機中のジョブを確認し、ジョブを GitHub のランナーに戻すときに、キャンセルして再実行するため。
Variables読み取りと書き込みジョブをテストマシンに送るか GitHub のランナーに戻すかを決める、リポジトリ変数 1 つを設定するため。
Metadata読み取りGitHub がすべての App に求めるもの。

Webhook やイベントは使いません。コード、プルリクエスト、issue、シークレットにはアクセスしません。

決してしないこと

  • コードを読んだり変更したりせず、push もしません。
  • Actions のシークレットを読みません(本番のシークレットを使うジョブは GitHub のランナーで動きます)。
  • 利用を選んでいないリポジトリでは何も実行しません。App をインストールしただけでは何も動きません。
  • フォークからのプルリクエストを、テストマシンで実行することはありません。

インストールと削除

リポジトリを追加する
organization のオーナーが App のインストールに追加します(organization › Settings › GitHub Apps › Monster Orange CI runners › Configure › Repository access)。そのあと、リポジトリ側でランナー変数を通してジョブを送るように設定します。
リポジトリを外す
インストールから外します。そのジョブは GitHub のランナーに戻ります。
アンインストールする
Organization › Settings › GitHub Apps › Monster Orange CI runners › Configure › Uninstall。すべてのジョブが再び GitHub のランナーで動きます。

Den について

Monster Orange Den Hub

チームのドキュメント、デザインモック、レビューコメントを、コードのそばに。

Den Hub は、チームのドキュメント、デザインモック、レビューコメントをコードのそばに置く場所です。選んだリポジトリを読み取り、issue、プルリクエスト、Markdown のドキュメントを一か所で見られるようにします。

権限

権限アクセス理由
Contents読み取り選んだフォルダーの Markdown(.md)ファイルを読み取り、ドキュメントを Den Hub に表示するため。ファイルを変更することはありません。
Issues読み取りと書き込みissue を読み取り、Den Hub に表示するため。書き込むのは一つの場合だけです。Den Hub で人が報告(バグや要望)を出すと、その人が選んだリポジトリに、その人が書いたタイトルと本文で issue を 1 つ作ります。自動のエージェントはこれを行えません。
Pull requests読み取りプルリクエストを読み取り、レビューと状況を Den Hub に表示するため。コメント、承認、マージは一切しません。
Metadata読み取りGitHub がすべての App に求めるもの。リポジトリ名と公開範囲が含まれます。

Webhook は使いません。GitHub からイベントを受け取らず、選んだリポジトリを定期的に確認します。

決してしないこと

  • コードの push、ファイルの編集や削除、ブランチの作成はしません。
  • 既存の issue やプルリクエストに、コメント、クローズ、ラベル付け、編集をしません。
  • プルリクエストを承認したりマージしたりしません。
  • 選んでいないリポジトリや、設定したフォルダー以外にあるファイルの中身を読み取りません。(Markdown ファイルを見つけるために、リポジトリのファイル名の一覧は取得します。)
  • Webhook を使いません。GitHub からイベントを受け取りません。
  • organization の設定、メンバー、Actions、シークレット、パッケージには触れません。

インストールと削除

インストールする
organization のオーナーが Den Hub のインストールリンクを開き、「Only select repositories」を選んでリポジトリを指定し、インストールします。そのあと Den Hub が、どの会社のインストールかを尋ねます。
削除する
GitHub › 自分の organization › Settings › GitHub Apps › Monster Orange Den Hub › Configure › Uninstall。個々のリポジトリだけを外すこともできます。Den Hub はすぐに読み取りをやめます。

Den Hub を見る

インストールの前に質問がありますか?

お気軽にお尋ねください。何かをクリックする前に、お答えします。

Monster Orange に問い合わせる