Install the Zinn® GitHub app so we can deploy without a long-lived token

連携によってもたらされるメリット

Zinn® GitHub アプリをインストールすると、個人用トークンを弊社に渡すことなく、リポジトリからサイトをデプロイし、プロジェクトボードを GitHub と同期させることができます。弊社が保持するのは、それ単体では役に立たないアプリのインストール番号のみであり、必要な都度、有効期限が1時間のトークンを生成します。これは組織にとってより適した選択肢です。特定の個人の所有物ではなく、担当者が退職しても機能が停止しないためです。

開始する前に

GitHub アカウント、またはアプリをインストールする組織のオーナー権限が必要です。サードパーティ製アプリを禁止している組織では、オーナーによる許可が必要です。それが不可能な場合は、代わりにきめ細やかなアクセス許可（fine-grained token）をご使用ください（GitHub アカウントの接続）。

1. GitHub でのキーの作成

作成するキーはありません。個人アカウントまたは組織に Zinn® GitHub アプリをインストールし、すべてのリポジトリまたはデプロイ対象のリポジトリのいずれかを選択します。

次にインストール番号を確認します。

• 個人アカウント — Settings → Applications → Installed GitHub Apps に移動し、Zinn® アプリの横にある Configure をクリックします。
• 組織 — Your organizations → Settings → GitHub Apps に移動し、Zinn® アプリの横にある Configure をクリックします。

そのページのアドレスバーの末尾にある数字（例：github.com/settings/installations/12345678）がインストール番号です。

2. ここでの接続

アプリは統合（Integrations）画面ではなく、使用される場所で選択します。

• サイトのリポジトリ接続で、GitHub (app install) を選択します。
• プロジェクトボードの GitHub リンクで、The Zinn® GitHub app を選択します。

Installation number を貼り付けて続行します。保存する前にインストールを確認するため、接続できない番号が保存されることはありません。

その後の動作

• アプリにアクセス権を付与したリポジトリがサイトのデプロイ元として表示され、プッシュによってデプロイが実行されます。
• 弊社が実行したすべての操作は、個人の名前ではなくアプリの名前で、GitHub 上のインストールの監査ログに記録されます。
• 追加のリポジトリを許可するには、同じ Configure ページでアプリのリポジトリアクセスを変更します。再接続の必要はありません。

接続できない場合

リポジトリが見つからない。 インストールは、選択したリポジトリのみを対象としています。Configure を開いて追加してください。

番号が拒否される。 アプリ自体の ID ではなくアドレスバーのインストール番号であること、およびアプリがまだインストールされていること（アンインストールされたアプリにはインストールが存在しません）を確認してください。

キーが拒否されたと表示される。 ほとんどの場合、以下の3つのいずれかが原因です。コピー時にスペースや改行が含まれていた、有効期限が切れていた、あるいはコピーした後にキーが取り消されたか再生成された場合です。新しいキーを作成してもう一度貼り付けてください。

接続は成功するが、後続の処理で失敗する。 キーの認証は成功していますが、操作に必要な権限が不足しています。上記に挙げた権限を持つ新しいキーを作成し、古い接続を切断してから新しいキーを接続してください。

接続解除

Integrations を開き、アカウントを見つけて Disconnect を押します。これにより、保存されているキーが即座に削除されます。そのキーを使用していたすべての処理は次のアクションで停止し、依存していた画面は、静かに失敗するのではなくその旨を表示します。

接続を解除しても、すでに実行された処理（お客様のアカウントで変更したレコード、デプロイ、設定など）は元に戻りません。キー自体が漏洩した可能性があると思われる場合は、ベンダー側でもキーを取り消してください。接続解除によって削除されるのは弊社のコピーであり、ベンダー側のものは削除されません。