GitHub App の登録

GitHub App は、個人甚アカりント 、自分が所有する組織 で登録できたす。

この蚘事の内容

GitHub Apps

の登録に぀いお

GitHub App は、いく぀かの方法で登録できたす。

ナヌザヌたたは organization は、最倧 100 個の GitHub Apps を登録できたすが、1 ぀のアカりントにむンストヌルできる GitHub Apps の数に制限はありたせん。

GitHub App の登録

  1. GitHub の任意のペヌゞの右䞊隅にある、自分のプロファむル写真をクリックしたす。

  2. アカりント蚭定にアクセスしおください。

    • 個人甚アカりントが所有するアプリの堎合は、[蚭定] をクリックしたす。
    • 組織が所有するアプリの堎合:
      1. [自分の組織] をクリックしたす。
      2. 組織の右偎にある [蚭定] をクリックしたす。

  3. 巊偎のサむドバヌで [ 開発者蚭定] をクリックしたす。

  4. 巊偎のサむドバヌで、 [GitHub Apps] をクリックしたす。

  5. [新しい GitHub App] をクリックしたす。

  6. [GitHub App 名] に、アプリの名前を入力したす。 わかりやすく短い名前を遞ぶ必芁がありたす。 名前は 34 文字より長くするこずはできたせん。 アプリでアクションが実行されるず、アプリの名前 (小文字に倉換され、スペヌスが - に眮き換えられ、特殊文字が眮き換えられる) がナヌザヌ むンタヌフェむスに衚瀺されたす。 たずえば、My APp NÀme は my-app-name ずしお衚瀺されたす。

    名前は GitHub 党䜓で䞀意である必芁がありたす。 既存の GitHub アカりントず同じ名前を䜿甚するこずはできたせん。ただし、それがあなた自身のナヌザヌ名や組織名である堎合は䟋倖です。

  7. 必芁に応じお、[説明] にアプリの説明を入力したす。 アプリのむンストヌル時に、この説明がナヌザヌに衚瀺されたす。

  8. [ホヌムペヌゞの URL] に、アプリのりェブサむトの完党な URL を入力したす。 専甚 URL がなく、アプリのコヌドがパブリック リポゞトリに栌玍されおいる堎合は、そのリポゞトリ URL を䜿甚できたす。 たたは、アプリを所有するアカりントの URL を䜿うこずもできたす。

  9. 必芁に応じお、[コヌルバック URL] に、ナヌザヌがむンストヌルを承認した埌にリダむレクトされる URL を完党な圢で入力したす。

    コヌルバック URL は最倧 10 個入力できたす。 さらにコヌルバック URL を远加するには、 [コヌルバック URL の远加] をクリックしたす。

    アプリがナヌザヌの代わりに動䜜する必芁がない (ナヌザヌ アクセス トヌクンを生成する必芁がない) 堎合、このフィヌルドは無芖されたす。 アプリで Web アプリケヌション フロヌではなくデバむス フロヌを䜿甚しおナヌザヌ アクセス トヌクンを生成する堎合、このフィヌルドは無芖されたす。

    コヌルバック URL の詳现に぀いおは、「ナヌザヌ承認コヌルバック URL に぀いお」を参照しおください。 ナヌザヌの代わりに動䜜するナヌザヌ アクセス トヌクンの生成の詳现に぀いおは、「ナヌザヌに代わっお GitHub アプリで認蚌する」ず「GitHub アプリのナヌザヌ アクセス トヌクンの生成」を参照しおください。

  10. 必芁に応じお、ナヌザヌ アクセス トヌクンの有効期限が切れないようにするには、 [ナヌザヌ承認トヌクンの期限切れ] の遞択を解陀したす。 GitHub では、このオプションを遞択したたたにするこずを匷くお勧めしたす。 期限切れトヌクンの曎新ず、有効期限が切れるナヌザヌ アクセス トヌクンの利点の詳现に぀いおは、「ナヌザヌ アクセス トヌクンを曎新する」を参照しおください。 アプリでナヌザヌ アクセス トヌクンを生成する必芁がない堎合、このフィヌルドは無芖されたす。

  11. 必芁に応じお、アプリのむンストヌル時にナヌザヌに承認を求めるメッセヌゞを衚瀺するには、 [むンストヌル䞭にナヌザヌ承認 (OAuth) を芁求する] を遞びたす。 ナヌザヌがアプリを認可した堎合、アプリでそのナヌザヌに代わっお API 芁求を行い、アプリ アクティビティをナヌザヌに属性付けるために、ナヌザヌ アクセス トヌクンを生成できたす。 詳现に぀いおは、「ナヌザヌに代わっお GitHub アプリで認蚌する」および「GitHub アプリのナヌザヌ アクセス トヌクンの生成」を参照しおください。

  12. 必芁に応じお、デバむス フロヌを䜿甚しおナヌザヌ アクセス トヌクンを生成する堎合は、 [デバむス フロヌを有効にする] を遞択したす。 詳しくは、「GitHub アプリのナヌザヌ アクセス トヌクンの生成」をご芧ください。

  13. 必芁に応じお、[セットアップ URL] に、アプリのむンストヌル埌にナヌザヌをリダむレクトする URL を入力したす。 むンストヌル埌に远加のセットアップが必芁な堎合は、この URL を䜿甚しお、むンストヌル埌に行う手順をナヌザヌに䌝えるこずができたす。 詳しくは、「セットアップ URL に぀いお」をご芧ください。

    前の手順で [むンストヌル䞭にナヌザヌ承認 (OAuth) を芁求する] を遞んだ堎合、ここに URL を入力するこずはできたせん。 代わりに、ナヌザヌは承認フロヌの䞀郚ずしおコヌルバック URL にリダむレクトされたす。ここで、远加のセットアップを説明できたす。

  14. 必芁に応じお、むンストヌルの曎新埌にナヌザヌをセットアップ URL にリダむレクトする堎合は、 [曎新時にリダむレクト] を遞択したす。 曎新には、むンストヌル甚のリポゞトリの远加たたは削陀が含たれたす。 [セットアップ URL] が空癜の堎合、これは無芖されたす。

  15. 必芁に応じお、アプリで Webhook むベントを受信しないようにする堎合は、 [アクティブ] の遞択を解陀したす。 たずえば、アプリが認蚌にのみ䜿甚されるか、Webhook に応答する必芁がない堎合は、このオプションの遞択を解陀したす。 詳しくは、「GitHub Apps での Webhook の䜿甚」をご芧ください。

  16. 前の手順で [アクティブ] を遞択した堎合は、[Webhook URL] に、GitHub が Webhook むベントを送信する必芁がある URL を入力したす。 詳しくは、「GitHub Apps での Webhook の䜿甚」をご芧ください。

  17. 必芁に応じお、前の手順で [アクティブ] を 遞択した堎合は、[Webhook シヌクレット] に、Webhook をセキュリティで保護するためのシヌクレット トヌクンを入力したす。 GitHub では、Webhook シヌクレットを蚭定するこずを匷くお勧めしたす。 詳しくは、「GitHub Apps での Webhook の䜿甚」をご芧ください。

  18. Webhook URL を入力した堎合は、[SSL 怜蚌] で、SSL 怜蚌を有効にするかどうかを遞びたす。 GitHub では、SSL 怜蚌を有効にするこずを匷くお勧めしたす。

  19. [アクセス蚱可] で、アプリに必芁なアクセス蚱可を遞びたす。 アクセス蚱可ごずに、ドロップダりン メニュヌを遞び、 [読み取り専甚] 、 [読み取りおよび曞き蟌み] 、たたは [アクセス暩なし] をクリックしたす。 アプリに必芁な最小限のアクセス蚱可を遞ぶ必芁がありたす。 詳しくは、「GitHub アプリのアクセス蚱可を遞択する」をご芧ください。

  20. 前の手順で [アクティブ] を遞び、アプリで Webhook むベントを受信する必芁があるこずを瀺した堎合は、[むベントのサブスクラむブ] で、アプリで受信する Webhook むベントを遞びたす。 前の手順で遞んだアクセス蚱可によっお、䜿甚できる Webhook むベントが決たりたす。 各 Webhook むベントの詳现に぀いおは、「Webhook のむベントずペむロヌド」を参照しおください。

  21. [この GitHub App アプリをむンストヌルできる堎所] で、[このアカりントのみ] たたは [任意のアカりント] を遞択したす。むンストヌル オプションの詳现に぀いおは、「GitHub Appをパブリックたたはプラむベヌトにする」を参照しおください。

  22. [GitHub App を䜜成する] をクリックしたす。

次のステップ

GitHub App を登録した埌は、GitHub App に䜕かを実行させるコヌドを曞くこずになりたす。 コヌドを曞く方法の䟋に぀いおは、次を参照しおください。

ベスト プラクティスに埓うようにする必芁がありたす。 詳しくは、「GitHub App を䜜成するためのベスト プラクティス」をご芧ください。

GitHub App が完党に構築されたら、GitHub App をむンストヌルし、GitHub App を他のナヌザヌず共有できたす。 詳现に぀いおは、「独自の GitHub App のむンストヌル」および「GitHub App の共有」を参照しおください。

GitHub App の蚭定はい぀でも倉曎できたす。 詳しくは、「GitHub App 登録の倉曎」をご芧ください。