circleciを使ってみる - kazu22002の技術覚書

PHPのアプリにcircleciを使ってみました。

github連携周りはすでにやっている状態です。できればdeployに使えるところまでやっていきたいと思って触っています。

circleci.com

Github
PHP Composer

プロジェクトに適用

circleciとgithubを連携すると、プロジェクトにリポジトリがリスト化されます。

circleciを適用したいリポジトリの「Set Up Project」ボタンを押し、config.yml templateの初期設定を書き込みする。を選択して実行します。

Sample ConfigはPHPを選択します。

そのまま「Commit and Run」を実行することで、ブランチの作成と「.circleci/config.yml」が追加されたブランチができあがります。

circleciの適用はこれでOKです。

config.ymlを確認

細かい設定は「.circleci/config.yml」にて記述します。

# PHP CircleCI 2.0 configuration file
#
# Check https://circleci.com/docs/2.0/language-php/ for more details
#
version: 2
jobs:
  build:
    docker:
      - image: circleci/php:7.1-node-browsers

    steps:
      - checkout

      - run: sudo apt update # PHP CircleCI 2.0 Configuration File# PHP CircleCI 2.0 Configuration File sudo apt install zlib1g-dev libsqlite3-dev
      - run: sudo docker-php-ext-install zip

      # Download and cache dependencies
      - restore_cache:
          keys:
            # "composer.lock" can be used if it is committed to the repo
            - v1-dependencies-{{ checksum "composer.json" }}
            # fallback to using the latest cache if no exact match is found
            - v1-dependencies-

      - run: composer install -n --prefer-dist

      - save_cache:
          key: v1-dependencies-{{ checksum "composer.json" }}
          paths:
            - ./vendor
      - restore_cache:
          keys:
            - node-v1-{{ checksum "package.json" }}
            - node-v1-
      - run: yarn install
      - save_cache:
          key: node-v1-{{ checksum "package.json" }}
          paths:
            - node_modules

      # prepare the database
      - run: touch storage/testing.sqlite
      - run: php artisan migrate --env=testing --database=sqlite_testing --force

      # run tests with phpunit or codecept
      #- run: ./vendor/bin/phpunit
      - run: ./vendor/bin/codecept build
      - run: ./vendor/bin/codecept run

PHPのプロジェクトのサンプルconfigを確認してみます。

やっていることは

buildするimageを指定
composer でPHPに必要なパッケージ取得
yarnでviewに必要なパッケージを取得
依存パッケージはcache
test

最初からcacheの書き方が書いてあるのがすごくありがたいです。ユースケースとして、CI/CDの速度の重要さをわかっていますね。

必要な内容にカスタマイズ

PHP7.4
yarnは使用していない
testは書いていない
動作するブランチを指定

buildされているimageはcircleciが用意してくれているimageを使用

circleci.com

あと初期のconfig.ymlの書き方は2だったが2.1の方が追加されている機能が使用できるらしいので、config.ymlの書き方を変更。

circleci.com

version: 2.1
executors:
  deploy_container:
    docker:
      - image: circleci/php:7.4-fpm
    working_directory: ~/repo

commands:
  composer_install_with_cache:
    steps:
      - restore_cache:
          keys:
            - v1-composer-deps-{{ checksum "composer.json" }}
            - v1-composer-deps-
      - run: composer install -n --prefer-dist
      - save_cache:
          key: v1-composer-deps-{{ checksum "composer.json" }}
          paths:
            - ./vendor

jobs:
  build:
    executor: deploy_container

    steps:
      - checkout
      - run: sudo apt update
      - composer_install_with_cache
      - save_cache: # ソースコードをキャッシュ
          key: v1-repo-{{ .Environment.CIRCLE_SHA1 }}
          paths:
            - ~/repo

workflows:
  version: 2
  release-workflow:
    jobs:
      - build
        filters:
          branches:
            only:
              - develop
              - master