Bitbucket または GitHub リポジトリを JIRA とリンクする
JIRA DVCS connector を利用して Bitbucket Cloud または GitHub (ホスティング または Enterprise) のアカウントを JIRA Software にリンクします。JIRA と Bibucket または GitHub を 連携させると、ソフトウェアのブランチ、コミット、メッセージ、そしてプルリクエストの全ては JIRA Software の課題をシームレスに参照することができます。これで JIRA Software は関連する課題に開発のアクティビティを表示させることができます。「JIRA を使った開発の効率化」を参照してください。
このページでは、Bitbucket や GitHub のアカウントを JIRA にリンクする方法について説明します。
JIRA Software が DVCS アカウントに接続する方法についてきちんと理解する
JIRA DVCS コネクターは JIRA Software Server を DVCS ホスティング サービス (Bitbucket、GitHub、または GitHub Enterprise) 上のアカウントにリンクさせます。よって、このコネクターは DVCSのアカウントから、DVCS のデータにアクセスするためのパーミッションが必要です。コネクターは OAuthアクセストークンを通じてこれを実行します。
OAuthのアクセストークンを DVCS (Bitbucket, GitHub, または GitHub Enterprise)上で作成します。連携させたいリポジトリを所有しているアカウントでアクセストークンを作成しなければいけません。トークンの作成方法は DVCS によって異なります。トークンの作成で生成される値は以下のようになります:
鍵 (キー) | DVCSで生成された文字列 |
シークレット | DVCSで生成された文字列 |
認証アカウント | トークンを認証するアカウント。 |
DVCS で鍵とシークレットを作成したら、JIRA Software に戻ってください。そこで、アカウント、OAuthのキーとシークレットのデータを JIRA Software に入力してください。
コネクターは キーとシークレットを自動的に信頼しません。JIRA Software に DVCSのアカウントとパスワードの組み合わせを提供することによって、鍵(キー)とシークレットで、DVCSへの接続を許可を行うかを尋ねます。許可を行うと、DVCS コネクターに以下を認めることになります:
Bitbcuket のアカウント保有者として、このサービス(JIRA Software)が Bitbucket で生成されたキーとシークレットを利用して接続を要求しているのを認めます。このサービスに対してアカウントのデータを利用することを許可します。
DVCS側で許可するアカウントは鍵とシークレットを作成したアカウントである必要はありません。許可アカウントはリンクする全てのリポジトリに対して管理者権限を持っている必要があります。
JIRA DVCS コネクターを利用して、DVCS アカウントを連携させる時、コネクターはそのアカウントによって所有されている全ての公開・プライベートリポジトリを検索します。コネクターは DVCS 上でリポジトリに対してポストコミットサービスの追加を行います。ポストコミットサービスは、リポジトリ上で、ユーザーがコミットによる変更を行うのを検知するコードの一部です。コミットが行われると、DVCS コネクターは処理するためのコミットメッセージを収集します。
JIRA Software 側では、DVCS によって保有されているリポジトリがDVCS アカウントページに表示されます。チームメンバーは個人の Bitbucket アカウントの下にリポジトリを作成できますが、所有者としてチームを割り当てます。これらのリポジトリは、リストの Bitbucket にも表示されます。
DVCS アカウントを Jira Software Server にリンクする
JIRA Software に Bitbucket や GitHub アカウントをリンクする際、OAuth のアクセストークンを DVCS ツール内で作成し、そのトークンを JIRA Software Server に追加します。
この手順を順に実行するには、リンクさせたい JIRA Software インスタンスと Bitbucket アカウントの両方で管理者権限が必要です。
ステップ 1. DVCS アカウント上で OAuth のアクセストークンを作成する
DVCS アカウント上で OAuth のアクセストークンを作成します。チームのリポジトリをリンクさせるには、チームアカウントでこれらのトークンを作成する必要があります。
リポジトリがホスティングされている DVCS - Bitbucket、GitHubの、またはGitHub Enterprise で新しい OAuth のトークンを生成します。
Bitbucket で新しいトークンを生成する
管理者権限を持つユーザーアカウントでログインします:
- アバター > Bitbucket 設定を選択します。
- (任意) チームアに接続する場合管理のドロップダウンよりチームを選択してください。
- アカウント管理の下にあるOAuthをクリックしてください。
- コンシューマの追加をクリックします。
以下の詳細を入力してください。
名前 この例では「 JIRA DVCS
」と入力します。説明 このトークンが何のために作成されたのかを想起させるような説明を入れます。 URL Jira Software のインスタンスの URL を入力します (例: https://example.atlassian.net) - 以下のパーミッションを選択します:
- アカウント: 書き込み
- リポジトリ: 管理者 (リポジトリへの書き込み権限はなし)
- プル リクエスト: 読み取り
These are the minimum permissions required by the JIRA DVCS connector.
Selecting additional permissions will have no adverse affects on the integration. - 保存をクリックします。
- 消費者の名前をクリックして、OAuth キーとシークレットの値を確認します。
- DVCS をブラウザで開いたまま、次のステップにいってください。
GitHub または GitHub Enterpriseで新しいトークンを生成する
管理者権限を持つユーザーアカウントでログインします:
- プロファイルの編集を選択します。
- アプリケーションを選択します。
- 新しいアプリケーションの登録を選択します。
- アプリケーション名に「
JIRA DVCS
」と入力します。 URL とコールバック URLの両方のフィールドに JIRA Software URL を入力します。アプリケーションの登録 を押します。
Jira ソフトウェア ベース URL (例: https://example.atlassian.net) を、ホームページ URL と認証コールバック URL フィールドの両方に入力するようにしてください。ダッシュボード URL (https://example.atlassian.net/secure/Dashboard.jspa2)は使用しないでください。
- DCON-467課題詳細を取得中... ステータス を参照してください。
For JIRA 6.2, the URL to use is
https://example.atlassian.net/plugins/servlet/oauth/authorize
.DVCS をブラウザで開いたまま、次のステップにいってください。
ステップ 2. JIRA Software 上で DVCS アカウントをリンクする
DVCS と JIRA Software のリンクを完了させるために以下を行います:
- 管理者権限を持つユーザーで JIRA Software にログインします。
- From the JIRA Software dashboard click the (settings) icon.
- アプリケーションを選択します。
- 左側の統合セクションで、DVCS アカウントを選択します。
- Bitbucket Cloud または GitHub アカウントをリンクをクリックします。
- ホスト値として Bitbucket Cloud を選択します。
チーム または ユーザーアカウント名を入力します。
例えば、
https://bitbucket.org/tutorials/markdowndemo
リポジトリを所有するアカウントをリンクさせたい場合、tutorials
をチーム アカウントまたはユーザー アカウントの値として入力します。tutorials
アカウントをリンクすると、markdowndemo
リポジトリだけではなく、このアカウントのすべてのリポジトリがリンクされます。- OAuth キー と OAuth シークレットの値をDVCS サイトからこのダイアログにコピーします。
GitHubの Client ID は OAuth キーと同じです。そして クライアントシークレットはOAuth シークレットと同じです。 - デフォルトの自動リンクとスマートコミットをそのままにする (推奨) または変更します。
[追加] をクリックします。
GitHub アカウントを接続しようとして、ブランクページにリダイレクトされた場合、「GitHub への DVCS 接続でブランクページが生成される」を参照してください。
- プロンプトでアクセスを許可します。
接続したアカウントとそのリポジトリが DVCS アカウントページに表示されます。最初の同期が自動的に開始します。
自動同期と、リンクの一時的な無効化
アカウントをリンクさせた後、JIRA Softwareは案件キーを参照するコミットの検索を自動的に開始します。サマリーには、同期結果とエラー (ある場合) が表示されます。DVCS リポジトリから JIRA Software へのコミットデータの同期には時間がかかる場合があります。同期が進むと、コミットが関連する案件に表示されます。必要に応じて、JIRA Softawre とリポジトリのリンクをいつでも有効化/無効化できます。
Bitbucket におけるリンクの表示方法
DVCS コネクターは 2 つの動作を実行します:
- リンクされたアカウントの統合アプリケーションリストに OAuth コンシューマを追加します。Bitbucket のリストを表示するには、自分のプロファイル画像をクリックし、 Bitbucket の設定をクリックします。アカウント管理にある OAuth セクションを選択すると、次のような画面が表示されます:
- DVCS コネクターはコミット後のサービスをアカウントの各リポジトリにプログラムによって追加します。このサービスを表示するには、リポジトリの上の (設定) から [サービス] をクリックします。以下のようなリストが表示されます。
DVCS コネクターはリンクを使用して、アカウントの新しいリポジトリを確認し、サービスをそこに追加します。これらすべての結果は "サービス" ページで確認できます。
JIRA Software プロジェクトでコミット情報がどのように表示されるかの例
開発者がコミットを作成する場合、 以下のように、JIRA Software 課題キーをコミットメッセージに追加する必要があります。
hg commit -m "DVCS-2 add a README file to the project."
hg push
JIRA Software は課題キーを使用してコミットを課題と関連付けます。これにより、コミットの要約を JIRA Software 課題の開発パネルに表示できるようになります。
詳細は、開発ツールとの連携 を参照してください。
必須のプロジェクト権限