Bitbucketリポジトリの設定

Liferay Cloud のオンボーディング メールには、 dxpcloud 組織でホストされている GitHub リポジトリへのリンクが含まれています。このリポジトリは、チームのプライベートなLiferay Cloud開発リポジトリのテンプレートであり、通常は10営業日後に削除されます。ユーザーは

1. プロビジョニングされたリポジトリを、ユーザー自身のプライベートリポジトリに転送します。

2. Webhookを使用して、プライベートリポジトリをLiferay CloudのJenkins（CI）サービスと統合します。

プロビジョニングされたリポジトリはGitHub上にありますが、Jenkinsサービスのバージョン3.2.0以降では、BitBucketリポジトリに移行できます。これは、BitBucketリポジトリへの管理者権限で実行する必要があります。

注記

リポジトリの管理者 は、クラウド コンソールのプロジェクトの管理者 と必ずしも同じではありません。

Jenkinsサービスの準備

Jenkinsfileをカスタマイズしている場合は、このガイドに従ってデフォルトのJenkinsfileを拡張してください。

Bitbucketリポジトリの作成

まず、新しいBitbucketリポジトリを作成します。

1. Bitbucket にアクセスしてください。

2. サイドバーの検索アイコンの下にある「+」アイコンをクリックしてください。

   

3. リポジトリ をクリックして、新しいリポジトリの作成を開始します。

   

4. リポジトリの名前を指定してください。

5. アクセスレベルがプライベートに設定されていることを確認してください。

6. README を含めるか？へ いいえ。

7. をクリックしてリポジトリを作成します。

GitHubからBitbucketへのデータ移行

プロビジョニングされたGitHubリポジトリを自分のBitbucketリポジトリに移行するには、以下の手順に従ってください。

1. プロビジョニングされたGitHubリポジトリをローカルにクローンします。

   git clone [e-mail]:dxpcloud/example.git
   

   注記

   既に別のプロバイダとの連携のためにリポジトリをクローンしている場合は、この手順をスキップして、同じクローン内で作業を進めることができます。

2. 新しいGitリモートを追加し、Bitbucketを指定します。

   git remote add bitbucket [e-mail]:example/example.git
   

3. クローンしたリポジトリを新しいリモートリポジトリにプッシュします。

   git push bitbucket master
   

GitHub リポジトリの作成、クローン、プッシュについてのヘルプが必要な場合は、 Bitbucket's documentationを参照してください。

BitbucketのAPIトークンを生成する

重要

Atlassian は、 Bitbucket アプリのパスワード を API トークンに置き換えています。 Bitbucketとの新規連携には、Atlassian APIトークンを使用してください。

アプリパスワードから API トークンに切り替えるには、新しい Atlassian API トークンを生成し、Jenkins サービスで LCP_CI_SCM_TOKEN と LCP_CI_SCM_USERNAME を更新します。そうしないと、Atlassianがアプリパスワードを削除した際に認証が機能しなくなります。

Bitbucketスコープを使用してAtlassian APIトークンを生成します。このウェブフックは、このトークンを使用してBitbucketで認証を行い、Jenkinsビルドをトリガーします。 APIトークンを作成するために使用するAtlassianアカウントは、Bitbucketリポジトリへの管理者レベルのアクセス権を持っている必要があります。

1. APIトークン管理ページ に移動し、プロンプトが表示されたらログインしてください。

2. をクリックして、スコープでAPIトークンを作成します。

3. トークンにラベルを付けてください。

4. トークンの有効期限を選択し、 次へ をクリックします。

5. アプリとして Bitbucket を選択し、 次へ をクリックします。

6. 必要な範囲を選択してください。

   • リポジトリ: 読み取り (read:repository:bitbucket)
   • プルリクエスト: 読み取り (read:pullrequest:bitbucket)
   • プルリクエスト: 書き込み (write:pullrequest:bitbucket)
   • Webhook: Read (read:webhook:bitbucket)
   • Webhook: 書き込み (write:webhook:bitbucket)

7. をクリックしてを作成します。

8. APIトークンの値をコピーし（二度と表示されません）、安全な場所に保管してください。

重要

• Bitbucketのスコープはそれぞれ独立しているため、必要なスコープはすべてトークンに追加する必要があります。例えば、プルリクエストとウェブフックのスコープのみの場合、ウェブフックのトリガーは機能せず、Jenkins はエラー で失敗します。 必要な権限スコープが 1 つ以上不足しています。既存のトークンに必要なスコープがない場合は、新しいトークンを作成し、 LCP_CI_SCM_TOKEN を更新します。
• 生成された API トークンを LCP_CI_SCM_TOKEN 環境変数に使用します。
• LCP_CI_SCM_USERNAME 環境変数には、トークンに関連付けられている Atlassian アカウントのメールアドレスを使用してください。

ブランチの種類とプレフィックスの確認

Liferay Cloudがブランチに正しくリンクできるようにするには、リポジトリで使用されているブランチプレフィックスの完全なリストを提供する必要があります。リポジトリで使用される各ブランチタイプには、リポジトリの設定で定義される独自のプレフィックスがあります。

the Bitbucket websiteで、メニューの左側の ［Repository settings］ ［Branching model］をクリックします。これにより、 ブランチモデル ページに移動し、各ブランチのプレフィックスが表示されます。これらのプレフィックスをそれぞれメモして、 LCP_CI_SCM_BITBUCKET_BRANCH_PREFIXES CI 環境変数に追加してください。

BitBucketをJenkinsサービスに接続する

最後に、Jenkinsサービスで環境変数を設定し、新しいリポジトリを指すようにします。

1. Liferay Cloud Consoleにログインし、 インフラ環境 にあるJenkinsサービスに移動します。

2. 環境変数 タブに移動します。

3. 以下の環境変数を設定してください。

名前	値
LCP_CI_SCM_PROVIDER	ビットバケット
LCP_CI_SCM_REPOSITORY_OWNER	[リポジトリ所有者]
LCP_CI_SCM_REPOSITORY_NAME	[リポジトリ名]
LCP_CI_SCM_TOKEN	[APIトークン]
LCP_CI_SCM_USERNAME	[アカウントメールアドレス]
LCP_CI_SCM_BITBUCKET_BRANCH_PREFIXES	[接頭辞一覧]

重要

セキュリティを強化するため、 LCP_CI_SCM_TOKEN の値を 秘密変数 に格納します。

LCP_CI_SCM_USERNAME を、API トークンに関連付けられた Atlassian アカウントのメールアドレスとして定義します。 LCP_CI_SCM_BITBUCKET_BRANCH_PREFIXES を、リポジトリのブランチで使用される敬称の全てのリストとして、スペースで区切って定義します。

これらの環境変数を更新した後、Jenkinsサービスが再起動します。新しいリポジトリにプッシュされたブランチとプルリクエストはすべて、これでトリガーされるはずです。

プライベートBitbucketサーバーへの接続

プライベートなBitbucketサーバーを使用するには、Jenkinsサービスに追加の環境変数を設定する必要があります。

名前	値
LCP_CI_SCM_SERVER_HOST	[private host URL]

LCP_CI_SCM_SERVER_HOST 変数を、プライベート Bitbucket サーバーのベース URL に設定します (例: http://private.bitbucket.org/)。これは、CIがビルドを生成したりリポジトリのブランチにリンクしたりする際に、コードベースを取得するために使用するサーバーURLを設定します。デフォルトでは、CI は Bitbucket のベース URL として https://bitbucket.org/ を使用します。

ビルドの検証

プッシュされたブランチやプルリクエストはビルドをトリガーし、そのビルドはLiferay Cloud Consoleの「ビルド」タブから確認またはデプロイできます。 Jenkinsサービスとの連携を設定した後、次のステップとして、これらのビルドを検証し、連携が成功したことを確認するのが良いでしょう。

プッシュされたブランチからのビルドの検証

新しいGitプッシュがJenkinsビルドをトリガーすることを確認します。

1. リポジトリに変更を加え（例えばファイルを追加するなど）、それをブランチにコミットします。

   git commit -m "Add file to test builds"
   

2. ブランチをBitBucketにプッシュする：

   git push bitbucket branch-name
   

3. Liferay Cloud Console の ビルド ページに移動します。

4. ビルドページに、プッシュしたブランチのビルドが表示されていることを確認してください。

プルリクエストからのビルドの検証

新しいプルリクエストがJenkinsビルドをトリガーすることを確認します。

1. 任意のブランチから develop ブランチへのプルリクエストを作成します。

2. プルリクエストに対して新しいビルドが作成されたことを確認してください。

3. Liferay Cloud Console の ビルド ページに移動します。

4. 該当するブランチのリンクをクリックし、適切なビルドでコミットしてください。

   

5. リンクが正しいBitBucketページにリダイレクトされることを確認してください。

関連トピック

• GitHubリポジトリの設定
• GitHubリポジトリの設定
• Azureリポジトリの構成