Jira 開発環境のセットアップ

アプリのインストールとテストには以下が必要です:

  • Jira Cloud インスタンス。アトラシアンは開発とテスト用に無料のインスタンスを提供しています。
  • インターネットで利用可能な GitLab インスタンス。アプリを動作させるには、Jira Cloud がインターネット経由で GitLab インスタンスに接続できる必要があります。このため、Gitpod または同様のクラウド開発環境を使用することをお勧めします。GDK での Gitpod の使用については、こちらを参照してください:

    Serveo やngrok のようなトンネリングツールを使ってはいけません。これらはセキュリティ上のリスクがあり、開発者のノートパソコンで実行してはいけません。

    Jira はアプリホストへのすべての接続が SSL であることを要求します。独自の環境をセットアップする場合は、SSL と適切な証明書を有効にすることを忘れないでください。

Jira にアプリをインストール

Jira にアプリをインストールします:

  1. Jira 開発モードを有効にして、アトラシアン マーケットプレイス以外のアプリをインストールします:

    1. Jira で、Jira 設定 > アプリ > アプリの管理 に移動します。
    2. アプリの管理] ページの一番下までスクロールし、[設定] を選択します。
    3. 開発モードを有効にする]を選択し、[適用]を選択します。
  2. アプリをインストールします:

    1. Jira で、Jira 設定 > アプリ > アプリの管理 に移動します。
    2. アプリのアップロード] を選択します。
    3. From this URLフィールドに、アプリ記述子へのリンクを入力します。ホストとポートはGitLabインスタンスを指している必要があります。

      使用例:

      https://xxxx.gitpod.io/-/jira_connect/app_descriptor.json
      
    4. アップロードを選択します。

    インストールが成功すると、アプリの管理の下にGitLab for Jira Cloudアプリが表示されるはずです。Getting Startedを選択すると、GitLab インスタンスからレンダリングされた設定ページを開くこともできます。

    アプリの記述子を変更する場合は、アプリをアンインストールしてから再インストールする必要があることに注意してください。

簡単なセットアップ

Gitpod や Jira Cloud インスタンスなどの外部依存を避けるために、Jira connect テストツールとローカルの GDK を使用します:

  1. をクローンします。 をクローンします。git clone git@gitlab.com:gitlab-org/manage/integrations/jira-connect-test-tool.git.
  2. アプリを起動しますbundle exec rackup.(アプリには、GDK GitLab がhttp://127.0.0.1:3000.で利用可能であることが必要です)。
  3. config/gitlab.yml を開き、jira_connect の config のコメントを外します。
  4. localhost 以外のドメインで GDK を実行する場合は、そのドメインをadditional_iframe_ancestors に追加する必要があります。例えば

    additional_iframe_ancestors: ['localhost:*', '127.0.0.1:*', 'gdk.test:*']
    
  5. GDKを再起動します。
  6. http://127.0.0.1:3000/-/profile/personal_access_tokens にアクセスしてください。
  7. api スコープで新しいトークンを作成し、トークンをコピーします。
  8. http://localhost:9292 にアクセスしてください。
  9. トークンを貼り付け、GitLab.com Jira Cloud アプリのインストールを選択します。

GitLab OAuth 認証フローのテスト

GitLab for Jira ユーザーは GitLab OAuth を使って GitLab と認証することができます。

以下のステップでは、GitLab OAuth のフローをテストするための環境設定について説明します:

  1. Gitpod セッションを開始します。
  2. GitLabインスタンスで、Admin > Applicationsに進みます。
  3. 以下の設定で新しいアプリケーションを作成します:
    • 名前GitLab for Jira
    • リダイレクト URI:YOUR_GITPOD_INSTANCE/-/jira_connect/oauth_callbacks
    • 信頼できるいいえ
    • コンフィデンシャルいいえ
    • スコープapi
  4. アプリケーションIDの値をコピーします。
  5. 管理>設定>一般に進みます。
  6. GitLab for Jira App を展開します。
  7. アプリケーション ID の値をJira Connect アプリケーション ID に貼り付けます。
  8. Jira Connect プロキシ URL に、YOUR_GITPOD_INSTANCE (例:https://xxxx.gitpod.io) を入力します。
  9. 公開鍵ストレージを有効にする] を選択します。
  10. 変更を保存を選択します。

トラブルシューティング

アプリのインストールに失敗します。

アプリのインストールに失敗した場合、データベースからjira_connect_installations を削除する必要があるかもしれません。

  1. データベースコンソールを開きます。
  2. TRUNCATE TABLE jira_connect_installations CASCADE; を実行してください。

ファイルへのアクセス権限がありません。

Gitpod を使用していて、Jira が記述子ファイルにアクセスできないというエラーが表示される場合は、以下の手順で GDK ポートを公開する必要があるかもしれません:

  1. Gitpod で GitLab ワークスペースを開きます。
  2. GDKが起動している状態で、右下のPortsを選択します。
  3. 左側のサイドバーで、GDKがリッスンしているポートを選択します (通常は3000)。
  4. ポートが非公開になっている場合は、ロックアイコンを選択して公開します。