GitHub for Atlassian 統合に関する FAQ
GitHub for Atlassian のセットアップに関する一般的な質問
作成者、レビュアー名、またはアイコンを Jira に表示できないのはなぜですか?
Jira 作業項目の開発パネルに作成者、レビュアー名、アイコンを表示するには、GitHub アカウントに関連付けられているメール アドレスが Jira アカウントのメール アドレスと一致している必要があります。これら 2 つのメール アドレスが異なる場合、アカウント名とアイコンは Jira に表示されません。この動作は、メールが一致している必要があるスマート コミットに似ています。
DVCS コネクタから GitHub for Atlassian に移行するにはどうすればよいですか?
Jira の組み込み DVCS コネクタを使用している場合は、次の要件を満たしていれば、GitHub for Atlassian 統合に移行することをお勧めします。
このアプリは http://GitHub.com (Enterprise Server を含むすべてのエディション) と Jira Cloud を正式にサポートしています。
Jira Server はサポートされていません。
まだプロンプトが表示されていない場合は、手動で移行を開始できます。
Jira Cloud アカウントにログインします。
[設定] () > [Jira アプリ] の順に選択します。
サイドバーの [統合] で、[DVCS アカウント] を選択します。
プロンプトに従って GitHub 接続をアップグレードします。
GitHub for Atlassian の権限要件
コードとメタデータの権限スコープは、開発情報を同期するためにデータが読み取られることを示しています。コードは Jira に保存されますか?
接続された GitHub リポジトリで発生するコミット、ブランチ、マージは、関連する Jira 作業項目の開発パネルに表示されます。コミット メッセージに作業項目キーが含まれている場合は常に、イベントが生成されて Jira に送信されるため、コミット メッセージで指定された作業項目を更新できます。アトラシアンのアプリでコミット メッセージとブランチ名を読み取ってデータを Jira 作業項目に正しくリンクするためには、コードへのアクセスが必要ですが、この処理中にコードが保存されることはありません。アトラシアンのアプリでは、単純に Jira にデータが送信されるだけです。
アプリでリポジトリに対するメタデータ アクセスが必要になるのはなぜですか?
メタデータへの読み取り専用アクセスは、すべての GitHub アプリを対象とした GitHub の必須要件です。(GitHub アプリに必要な権限の詳細については、こちらをご確認ください。)このアクセスにより、GitHub アプリが多数のリソースのさまざまな読み取り専用エンドポイントにアクセスできるようになります。アトラシアンのアプリからリポジトリのコードを参照できるようになりますが、アトラシアンはソフトウェアのセキュリティを非常に重視しています。アトラシアンでは、コードの脆弱性を常時監視し、安全に使用できるようにするプロセスを整備しています。さらに、メタデータ権限に関する GitHub ドキュメントには、「これらのエンドポイントから機密性の高い非公開リポジトリ情報が漏洩することはありません」と記載されています。まだアプリにアクセスを許可したくないリポジトリがある場合は、次のように対応できます。
アプリをインストールする際にアクセスを許可するリポジトリを選択します。
GitHub 設定ページ (または [Connect an org (組織を接続)] ページ) で編集アイコンを選択して、GitHub 設定をアップデートします。
プル リクエスト、コンテンツ、作業項目に対して読み取りと書き込みの権限が必要になるのはなぜですか?
これは、アプリでプル リクエストや作業項目のコメントから Jira 作業項目へのリンクを作成するために必要です。コメントを作成して作業項目キーを角括弧で囲んで含めると、アプリから Jira への ping が実行され、その作業項目キーが Jira スペースに存在するかどうかが確認されます。一致する作業項目が見つかった場合、簡単にナビゲーションできるようにリンクが作成されます。コンテンツについては、リクエストに応じてブランチを作成するために書き込みアクセスが必要です。
今後、アプリに新しい権限を必要とする変更が加えられた場合はどうなりますか?新しい権限を承認しつつ、以前にリクエストされた権限のうち不要なものや不安に感じるものは無視してもよいですか?
残念ながら非対応です。GitHub アプリについては、権限を細かく設定できないという点で制限があります。
スマート コミット
スマート コミットが機能しないのはなぜですか?
スマート コミットを使用すると、自分とそのチームによる作業項目へのコメント、作業項目のトランジション、タイム トラッキングの追加が簡単にできるようになります。チームに対してこの機能を有効にするための要件は次のとおりです。
GitHub アカウントのメール アドレスと Jira アカウントのメール アドレスが一致していること。たとえば、GitHub の mypersonal@email.com と Jira の mywork@email.com では、スマート コミットが機能しません。ただし、mypersonal@email.com と mypersonal@email.com では機能します。
GitHub の [Keep my email addresses private (メール アドレスを非公開にする)] チェックボックスをオフにしていること。このチェックボックスをオンにすると、Webhook が実行される際に、GitHub からペイロードの一部としてメール アドレスが送信されなくなります。その結果、Jira では、メール間の不一致として処理され、上記の条件が満たされなくなります。GitHub でこの設定を更新するには、[Settings (設定)] に移動し、[Emails (メール)] を選択して、[Keep my email addresses private (メール アドレスを非公開にする)] の横にあるチェックボックスをオフにします。
トランジションするときに正しい名前を使用すること。ある列から別の列に作業項目をトランジションする場合は、作業項目のトランジション先の列に同じ名前を使用してください。たとえば、作業項目に完了のフラグを付け、この列の名前が「Done (完了)」である場合は、コミット メッセージに「#done」を含める必要があります。(代わりに「#closed」や「#complete」などを使用しても、これらの単語がワークフローにステータスとして含まれていない限り、機能しません。)
ワークフローの列を「ジャンプ」しないこと。トランジションがうまくいかない場合は、チームの管理者が設定したワークフローに従っていることを確認してください。たとえば、「作業前」、「進行中」、「完了」という 3 つの列があるが、管理者が作業項目を「作業前」から「完了」に直接移動できないというルールを適用している場合、作業項目を「作業前」から「完了」にトランジションしようとするスマート コミットは失敗します。このシナリオでは、まず作業項目を「進行中」に移動する必要があります。
タイム トラッキングを有効にし、各作業項目タイプに追加していること。コミット メッセージに
#time 1w 2d 4h 30mのような内容を追加した後、作業項目でタイム トラッキングが表示されない場合は、チームの管理者にサイトの設定を確認するよう依頼してください。タイム トラッキングの設定方法については、こちらをご確認ください。
データをバックフィルする
データのバックフィルに長い時間がかかります。いつ Jira にデータが表示されますか?
GitHub for Atlassian アプリを介して GitHub 組織を Jira に接続すると、「バックフィル」と呼ばれるプロセスが開始されます。このプロセスは、GitHub の履歴データから作業項目キーを探すものです。作業項目キーが見つかった場合、開発データが Jira の既存の作業項目にリンクされます。
組織に含まれるデータ量が少ない場合は、バックフィルのプロセスも比較的速く、数分で完了します。しかし、組織に大量のデータが含まれている場合は、バックフィルのプロセスに時間を要します。幸い、Github 組織を Jira に接続すると、新しいブランチ、コミット、プル リクエストですぐに作業項目キーを使用できます。また、この新しいデータは Jira にただちに表示されます。
GitHub for Atlassian 統合を使い始める前に、すべてのデータのバックフィルが完了するのを待つ必要はありますか?
いいえ。バックフィルの役割は、すべての履歴データを取り込むことです。これにより、アプリをインストールする前に作業項目キーが参照されていた場合、最終的にそのデータを Jira で確認できるようになります。つまり、アプリでは Webhook イベント (リアルタイム データ) のリッスンと応答がすぐに開始されるため、チームで即座にアプリを使い始めることができます。
GitHub Enterprise Server
このセクションは、GitHub for Atlassian アプリを使用している GitHub Enterprise Server のお客様に向けた内容となっています。利用開始のサポートが必要な場合は、「Jira を GitHub Enterprise Server と統合する」を参照してください。
GitHub Enterprise Server に接続できないのはなぜですか?
GitHub Enterprise Server との接続に問題が発生する一般的な理由は次のとおりです。
アトラシアン IP アドレスを許可する必要があります。GitHub IP 許可リストの設定を表示する か、 サポート チームにお問い合わせください。
SAML SSO は GitHub Enterprise Server ではサポートされていません (ただし、GitHub Enterprise Cloud は SAML SSO をサポートしています)。
アトラシアン向け GitHub はリバース プロキシをサポートしていません。
自己署名証明書 (SSL) に問題があります。
アトラシアン アプリ向け GitHub で非公開キーと GitHub クライアント シークレットを更新するにはどうすればよいですか?
GitHub の設定ページが Jira に表示されます。
アップデートする GitHub アプリを見つけて、[その他のアクション] (⋯)、[編集] の順に選択します。
GitHub のクライアント シークレットや非公開キーを編集し、[更新] を選択して変更を保存します。
複数の GitHub サーバーとアプリを接続できますか?
はい。1 つの Jira アカウントに複数の GitHub サーバーを接続できます。サーバーごとに複数の GitHub アプリを追加して、任意の GitHub 組織を Jira に接続することもできます。GitHub アプリのレート制限については、こちらをご確認ください。
複数の Jira サイトにプライマリ GitHub アプリ 1 つを作成できますか?
いいえ、それぞれの GitHub アプリは 1 つの Jira インスタンスにしか接続できません。これは、セキュリティを維持してデータ漏えいを防ぐためです。
アプリの自動作成に GitHub Enterprise Server バージョン 3.1 が必要な理由は何ですか?
アプリの自動作成は、バージョン 3.1 で追加された
callback_urlのサポートに依存しています。GitHub for Atlassian アプリは、GitHub Actions に依存する 3 つのイベントをサブスクライブしています。これは、バージョン 3.0 以降で利用できます。
GitHub は定期的に新しいバージョンをリリースして、古いバージョンのサポートを終了しています。バージョン 3.1 以降にアップグレードすると、最新の機能、バグ修正、改善、セキュリティ アップデートを常に新しい状態に保つことができます。
Server をアップグレードするには、GitHub のサポート ドキュメント「GitHub Enterprise Server のアップグレード」の手順に従ってください。
ワークフローの実行、デプロイのステータス、またはコード スキャン イベントのデータが表示されない理由は何ですか?
GitHub Enterprise Server で GitHub Actions を有効にする必要がある場合があります。GitHub Actions を有効にするには、GitHub のサポート ドキュメント「GitHub Enterprise Server 3.2 の GitHub Actions を使い始める」の手順に従ってください。
アトラシアン向け GitHub はどのようにしてデータを取得しますか?
アトラシアン アプリ向け GitHub では、開発データを取得して Jira に送信するために、GitHub Enterprise Server にアクセスする必要があります。これを機能させるには、ネットワーク構成で、アトラシアンの IP アドレス リストから GitHub Enterprise Server への呼び出しを許可し、GitHub Enterprise Server から呼び出して HTTPS 経由で github.atlassian.com ドメインのアトラシアン Server に到達できるようにする必要があります。
アトラシアン アプリ向け GitHub は GitLab をサポートしていますか?
いいえ、Jira を GitLab と統合するには、GitLab for Jira Cloud アプリを使用してください。
この内容はお役に立ちましたか?