Getting Started
ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、 こちら までご連絡ください。

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. サイドバーの検索アイコンの下にある「+」アイコンをクリックします。

    「+」アイコンをクリックして、新しいBitBucketリポジトリの作成を開始します。

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

    新しいリポジトリの詳細を入力してください。

  4. リポジトリの名前を指定します。

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

  6. README を含めるか? へ いいえ

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

GitHubからBitbucketへの転送

以下の手順に従って、プロビジョニング済みの GitHub リポジトリを自分の Bitbucket リポジトリに転送します:

  1. プロビジョニング済みのGitHubリポジトリをローカルでクローンします:

    git clone git@github.com:dxpcloud/example.git
    

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

  2. 新しいGitリモートを追加し、Bitbucketをポイントします:

    git remote add bitbucket git@bitbucket.org: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_TOKENLCP_CI_SCM_USERNAME を更新します。 そうしないと、Atlassianがアプリパスワードを削除した際に認証が機能しなくなります。

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

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

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

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

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

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

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

    • プルリクエスト: 読む
    • プルリクエスト: 書き込み
    • Webhook: 読み取り
    • Webhook: 書き込み
  7. [作成]をクリックします。

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

重要

生成された 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 リポジトリのデフォルトのブランチタイプ(および敬称)は、bugfix/、feature/、hotfix/、release/ です。

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

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

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

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

  3. 以下の環境変数を設定します:

名前
LCP_CI_SCM_PROVIDERbitbucket
LCP_CI_SCM_REPOSITORY_OWNER[repo owner]
LCP_CI_SCM_REPOSITORY_NAME[repo name]
LCP_CI_SCM_TOKEN[APIトークン]
LCP_CI_SCM_USERNAME[アカウントメールアドレス]
LCP_CI_SCM_BITBUCKET_BRANCH_PREFIXES[list of 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. Builds ページで、プッシュされたブランチのビルドが表示されることを確認します。

プルリクエストからのビルドの確認

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

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

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

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

  4. ブランチのリンクをクリックして、適切なビルドでコミットします。

    Buildsページで、ブランチのリンクを確認し、ビルドをコミットします。

  5. リンクが正しいBitBucketページにリダイレクトすることを確認します。