BitbucketのpipelinesでXserverへの自動デプロイ

作業効率化のためのメモです。

自動デプロイまでの手順

Bitbucketの管理画面にログイン
あらかじめプロジェクトとリポジトリを作成、リポジトリのページを開きます。
左メニューにある「Repository settings」をクリックして、Repository detailsのページを開きます。
左メニューにある「Setting」をクリックして、Pipelines settingsのページを開きます。
「Enable Pipelines」のトグルを切り替えて有効化します。
「Configure bitbucket-pipelines.yml」をクリック
リポジトリのブランチのルートディレクトリに「bitbucket-pipelines.yml」を作成、プッシュします。

bitbucket-pipelines.yml

image: bitnami/git

pipelines:
  branches:
    master:
      - step:
          script:
            - echo "Pipeline Init"
            - apt-get update
            - apt-get -qq install git-ftp
            - echo "Initiating Push"
            - git ftp init --user $FTP_USERNAME --passwd $FTP_PASSWORD $FTP_HOST$FTP_DIRECTORY
            - echo "Done Pushing"

＜注意！＞

一度、FTPを行ったら、「git ftp init」部分を「git ftp push」に書き換えます。（★忘れがちなので要注意です！）
古いブログ記事で記載されている「image: samueldebruyn/debian-git」は動作しないので、「image: bitnami/git」にしてください。
（2021/11/16現在の情報）

環境変数の登録

左メニューにある「Repository variables」をクリックして、Repository variablesのページを開きます。
環境変数に以下の値を登録しておきます。（全部secureでOK）

環境変数	意味	入力例
FTP_USERNAME	FTPユーザー名	xsample
FTP_PASSWORD	FTPパスワード	********
FTP_HOST	FTPホスト名	sv***.xserver.jp
FTP_DIRECTORY	デプロイ先のディレクトリ	/example.com/public_html/deploy-xxxxxx

※ディレクトリの部分は契約アカウントによってドメイン部分が変わります。例では「deploy-xxxxxx」はデプロイ先にする場合です。

自動デプロイ時の手順および確認方法

Gitリポジトリにプッシュすると、Pipelineから自動デプロイが作動します。
左メニューにある「Deployments」をクリックして、Deploymentsのページを開きます。
「Edit YAML configuration」をクリック、bitbucket-pipelines.yml がリポジトリ上にあれば、内容が確認できます。
一度、FTPを行ったら、「git ftp init」部分を「git ftp push」に書き換えます。
（★忘れがちなので要注意です！　大事なことなので2度書きます）
左メニューの「Pipelines」でデプロイ状況が確認できます。

今回の記事は以上です。
次回の記事は、同じ内容でGitLab版になります。