GitHub アプリを手動で作成します。

この情報は、GitHub for Jira ベータ トライアルに参加している GitHub Enterprise Server のお客様向けです。ベータ トライアルに参加したい場合は、こちらからご登録ください

GitHub Enterprise Server アカウントを Jira Software に接続するには、GitHub インスタンスにアプリを作成する必要があります。アプリは自動でも手動でも作成できます。このページでは、アプリを手動で作成する方法をご説明します。

入門ガイド

  1. GitHub Enterprise Server アカウントにログインします。

  2. http(s)://<your-domain>/settings/apps に移動します。これにより、開発者の設定が表示されます。また、右上のプロファイル画像をクリックして、[ユーザー設定] > [開発者設定] を選択することでも、これらの設定に移動できます。

  3. "開発者設定" ページの左側のパネルで [GitHub アプリ] を選び、[新しい GitHub アプリ] を選択します。

GitHub で新しい GitHub アプリを登録する

GitHub アプリの名前を作成する

アプリの名前を入力します。どんな名前でも選べますが、サーバーで一意でなければなりません。

GitHub の "GitHub アプリの名前" フィールドを示すスクリーンショット

次にアプリの説明を追加します。この手順は任意です。

"GitHub アプリの説明" フィールドに空白のエントリが表示されているスクリーンショット

ホームページの URL を作成する

ホームページ入力用の URL は、次のような構成にドメイン名とアプリ名を挿入することで作成します。

http(s)://<domain>/apps/<github-app-name>

このフィールドへの入力内容は次のようになります。

GitHub の "ホームページの URL" フィールドを示すスクリーンショット

アプリが作成されたら、このホームページ URL から GitHub アプリのホームページに移動します。

Jira でアプリの手動作成 URL を見つける

次に、Jira のアプリ手動作成ページからいくつかの URL をコピーして、GitHub のアプリ作成フォームに貼り付けます。

コールバック URL をコピーする

  1. Jira の "ユーザー認証コールバック URL" フィールドから URL をコピーします。これは次のようになります: https://github.atlassian.com/github/<UUID>/callback

  2. この URL を GitHub の "コールバック URL" フィールドに貼り付けます。

セットアップ URL をコピーする

  1. Jira の "セットアップ URL" フィールドから URL をコピーします。これは次のようになります: https://github.atlassian.com/github/<UUID>/setup

  2. この URL を GitHub の "セットアップ URL" フィールドに貼り付けます。

Webhook URL をコピーしてシークレットを追加する

  1. Jira の "Webhook URL" フィールドから URL をコピーします。これは次のようになります: https://github.atlassian.com/github/<UUID>/webhooks

  2. この URL を GitHub の "Webhook URL" フィールドに貼り付けます。

  3. Webhook シークレットを追加します。GitHub はこれをオプションのフィールドとしてリストしていますが、Jira では Webhook イベントをリッスンして処理するために必須となります。そのため、統合を正常に完了するには、何かを入力する必要があります。ランダムに生成された文字列を入力するか、「mycompanyisawesome」のような単純な文字列を追加できます。

GitHub で権限を指定する

GitHub でリポジトリと組織レベルで権限を付与し、イベントをサブスクライブする必要があります。これらの権限とサブスクリプションにより、Jira は GitHub からのイベントをリッスンできるため、Jira プロジェクトに開発データを入力できます。

リポジトリ権限

次のリポジトリ権限を追加します。

  • アクション: 読み取り専用

  • コンテンツ: 読み取り & 書き込み

  • デプロイ: 読み取り専用

  • 課題: 読み取り & 書き込み

  • メタデータ: 読み取り専用 (GitHub では必須の権限)

  • プル リクエスト: 読み取り & 書き込み

組織的な権限

次の組織的権限を追加します。

  • メンバー: 読み取り専用

イベントのサブスクライブ

次のイベント サブスクリプションを選択します。

  • セキュリティ勧告

  • コミット コメント

  • 作成

  • 削除

  • デプロイのステータス

  • 課題コメント

  • 課題

  • Pull request

  • プル リクエストのレビュー

  • プッシュ

  • リポジトリ

  • ワークフローの実行

GitHub アプリの詳細を入力する

フォームのすべてのフィールドを確認したら、[GitHub アプリを作成] を選択して保存します。次のセクションに進む前に、この手順を完了する必要があります。

Jira の "アプリの手動作成" ページに入力する

GitHub でアプリを正常に作成したら、Jira で "アプリの手動作成" ページに入力する必要があります。

  1. GitHub から次のフィールドをコピーして、Jira の "アプリの手動作成" ページの各フィールドに貼り付けます。

    1. アプリ ID

    2. クライアント ID

  2. GitHub で [新しいクライアント シークレットを生成] を選択して、ページが更新されるのを待ってから、これをコピーして Jira の "GitHub クライアント シークレット" フィールドに貼り付けます

  3. PEM ファイルを生成して自動的にダウンロードするには、GitHub で [非公開キーを生成] を選択します。このファイルを Jira の "非公開キー" フィールドにアップロードします。

  4. 次のフィールドが GitHub と Jira で一貫していることをご確認ください。

    1. GitHub アプリの名前

    2. Webhook シークレット - これは、アプリを作成したときに GitHub で追加したシークレットです。これを今すぐ表示するには、GitHub の Webhook シークレット フィールドで [編集] を選択して、値を Jira にコピーします。

その他のヘルプ