注: GitHub ホステッド ランナーは、現在 GitHub Enterprise Server でサポートされていません。 GitHub public roadmap で、今後の計画的なサポートの詳細を確認できます。
CircleCIとGitHub Actionsは、どちらも自動的にコードのビルド、テスト、公開、リリース、デプロイを行うワークフローを作成できます。 CircleCIとGitHub Actionsは、ワークフローの設定において似ているところがあります。
ワークフローの設定ファイルはYAMLで書かれ、リポジトリに保存されます。 ワークフローには1つ以上のジョブが含まれます。 ジョブには1つ以上のステップもしくは個別のコマンドが含まれます。 ステップもしくはタスクは、再利用とコミュニティとの共有が可能です。 詳しくは、GitHub Actions のコア概念 に関するページをご覧く� さい。
CircleCIから移行する際には、以下の差異を考慮してく� さい。
CircleCIの自動テストの並列性は、ユーザが指定したルールもしくは過去のタイミングの情� �に基づいて、自動的にテストをグループ化します。 この機能はGitHub Actionsには組み込まれていません。 コンテナはユーザのマッピングが異なるので、Dockerコンテナ内で実行されるアクションは、権限の問題に敏感です。 Dockerfile で USER 命令を使わなければ、これらの問題の多くを回避できます。 GitHub Enterprise Server ホスト ランナーの Docker ファイルシステ� について詳しくは、「GitHub ホステッド ランナーについて 」を参照してく� さい。 CircleCI によって、config.yml ファイルに workflows が定義されます。これにより、1 つ以上のワークフローを構成できるようになります。 GitHub Enterprise Server は、ワークフローごとに 1 つのワークフロー ファイルを必要とするので、workflows を宣言する必要はありません。 config.yml に構成されている各ワークフローに対して、新しいワークフロー ファイルを作成する必要があります。
CircleCI と GitHub Actions のどちらを使っても、同様の構文を使って、構成ファイル内に jobs が構成されます。 CircleCI ワークフロー内で requires を使ってジョブ間に依存関係を構成する� �合は、同様の GitHub Actions needs 構文を使うことができます。 詳細については、GitHub Actions のワークフロー構文 に関するページを参照してく� さい。
CircleCIとGitHub Actionsは、どちらもワークフロー中のタスクを再利用し、共有するための仕組みを提供しています。 CircleCIはorbsという概念を利用します。これはYAMLで書かれ、ワークフロー中で再利用できるタスクを提供します。 GitHub Actionsはアクションと呼ばれる強力で柔軟な再利用できるコンポーネントを持っており、これはJavaScriptファイルもしくはDockerイメージで構築できます。 GitHub Enterprise Server の API やパブリックに利用可能なサードパーティ API との統合など、リポジトリと相互作用するカスタ� コードを書いてアクションを作成することができます。 たとえば、アクションで npm モジュールを公開したり、緊急の問題が発生したときに SMS アラートを送信したり、実稼働可能なコードをデプロイしたりできます。 詳細については、「アクションを作成する 」を参照してく� さい。
CircleCIは、YAMLのアンカーとエイリアスでワークフローの部分を再利用できます。 GitHub Actions は、マトリックスを使って、再利用性についてのほとんどのニーズをサポートしています。 マトリックスの詳しい情� �については、「ジョブにマトリックスを使う 」を参照してく� さい。
CircleCIとGitHub Actionsは、どちらもDockerイメージ内でのステップの実行をサポートします。
CircleCIは、共通の依存関係を持つ一連のビルド済みのイメージを提供します。 これらのイメージでは、USER が circleci に設定されていますが、これにより、権限が GitHub Actions と競合します。
GitHub Actionsへの移行に際しては、CircleCIの構築済みイメージから離脱することをおすすめします。 多くの� �合、必要な追� の依存関係のインストールにアクションを使うことができます。
Docker ファイルシステ� について詳しくは、「GitHub ホステッド ランナーについて 」を参照してく� さい。
GitHub ホステッド ランナー イメージで使用可能なツールとパッケージについて詳しくは、GitHub ホステッド ランナーの仕様 に関するページを参照してく� さい。
CircleCIとGitHub Actionsは、設定ファイル内での環境変数の設定と、CircleCIもしくはGitHub Enterprise ServerのUIを使ったシークレットの作成をサポートしています。
詳しい情� �については、環境変数の使用 と暗号化されたシークレットの作成と使用 に関するページを参照してく� さい。
CircleCIとGitHub Actionsは、設定ファイル中で手動でファイルをキャッシュする方法を提供しています。
GitHub Actions キャッシュは、GitHub.com または GitHub Enterprise Server 3.5 以降でホストされているリポジトリでのみ使用できます。 詳細については、「ワークフローを高速化するための依存関係のキャッシュ 」を参照してく� さい。
GitHub Actionsは、CircleCIのDocker Layer Caching（DLC）に相当する機能を持っていません。
CircleCIとGitHub Actionsは、どちらもジョブ間でデータを永続化するための仕組みを提供しています。
以下は、CircleCIとGitHub Actionsの設定構文の例です。
CircleCI GitHub のアクション - persist_to_workspace: root: workspace paths: - math-homework.txt ... - attach_workspace: at: /tmp/workspace - name: Upload math result for job 1 uses: actions/upload-artifact@v2 with: name: homework path: math-homework.txt ... - name: Download math result for job 1 uses: actions/download-artifact@v2 with: name: homework
詳細については、「アーティファクトを使用してワークフロー データを永続化する 」を参照してく� さい。
どちらのシステ� でも、データベース、キャッシング、あるいはその他の依存関係のための追� コンテナを含めることができます。
CircleCI では、config.yaml で最初に示されているイメージが、コマンドの実行で主に使用されているイメージです。 GitHub Actions では、明示的なセクションを使います。主要なコンテナーには container を使い、追� のコンテナーのリストを services に表示します。
以下は、CircleCIとGitHub Actionsの設定構文の例です。
CircleCI GitHub のアクション --- version: 2.1 jobs: ruby-26: docker: - image: circleci/ruby:2.6.3-node-browsers-legacy environment: PGHOST: localhost PGUSER: administrate RAILS_ENV: test - image: postgres:10.1-alpine environment: POSTGRES_USER: administrate POSTGRES_DB: ruby26 POSTGRES_PASSWORD: "" working_directory: ~/administrate steps: - checkout - run: bundle install --path vendor/bundle - run: dockerize -wait tcp://localhost:5432 -timeout 1m - run: cp .sample.env .env - run: bundle exec rake db:setup - run: bundle exec rake workflows: version: 2 build: jobs: - ruby-26 ... - attach_workspace: at: /tmp/workspace name: Containers on: [push ] jobs: build: runs-on: ubuntu-latest container: circleci/ruby:2.6.3-node-browsers-legacy env: PGHOST: postgres PGUSER: administrate RAILS_ENV: test services: postgres: image: postgres:10.1-alpine env: POSTGRES_USER: administrate POSTGRES_DB: ruby25 POSTGRES_PASSWORD: "" ports: - 5432 :5432 options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5 steps: - name: Setup file system permissions run: sudo chmod -R 777 $GITHUB_WORKSPACE /github /__w/_temp - uses: actions/checkout@v2 - name: Install dependencies run: bundle install --path vendor/bundle - name: Setup environment configuration run: cp .sample.env .env - name: Setup database run: bundle exec rake db:setup - name: Run tests run: bundle exec rake
詳細については、「サービス コンテナーについて 」を参照してく� さい。
以下は実際の例です。 左側には、thoughtbot/administrator リポジトリの実際の CircleCI config.yml が表示されています。 右は、同等のGitHub Actionsを示しています。
CircleCI GitHub のアクション --- version: 2.1 commands: shared_steps: steps: - checkout - restore_cache: name: Restore bundle cache key: administrate-{{ checksum "Gemfile.lock" }} - run: bundle install --path vendor/bundle - save_cache: name: Store bundle cache key: administrate-{{ checksum "Gemfile.lock" }} paths: - vendor/bundle - run: dockerize -wait tcp://localhost:5432 -timeout 1m - run: cp .sample.env .env - run: bundle exec rake db:setup - run: bundle exec rake default_job: &default_job working_directory: ~/administrate steps: - shared_steps - run: bundle exec appraisal install - run: bundle exec appraisal rake jobs: ruby-25: <<: *default_job docker: - image: circleci/ruby:2.5.0-node-browsers environment: PGHOST: localhost PGUSER: administrate RAILS_ENV: test - image: postgres:10.1-alpine environment: POSTGRES_USER: administrate POSTGRES_DB: ruby25 POSTGRES_PASSWORD: "" ruby-26: <<: *default_job docker: - image: circleci/ruby:2.6.3-node-browsers-legacy environment: PGHOST: localhost PGUSER: administrate RAILS_ENV: test - image: postgres:10.1-alpine environment: POSTGRES_USER: administrate POSTGRES_DB: ruby26 POSTGRES_PASSWORD: "" workflows: version: 2 multiple-rubies: jobs: - ruby-26 - ruby-25 name: Containers on: [push ] jobs: build: strategy: matrix: ruby: [2.5 , 2.6 .3 ] runs-on: ubuntu-latest env: PGHOST: localhost PGUSER: administrate RAILS_ENV: test services: postgres: image: postgres:10.1-alpine env: POSTGRES_USER: administrate POSTGRES_DB: ruby25 POSTGRES_PASSWORD: "" ports: - 5432 :5432 options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5 steps: - uses: actions/checkout@v2 - name: Setup Ruby uses: eregon/use-ruby-action@477b21f02be01bcb8030d50f37cfec92bfa615b6 with: ruby-version: ${{ matrix.ruby }} - name: Cache dependencies uses: actions/cache@v2 with: path: vendor/bundle key: administrate-${{ matrix.image }}-${{ hashFiles('Gemfile.lock') }} - name: Install postgres headers run: | sudo apt-get update sudo apt-get install libpq-dev - name: Install dependencies run: bundle install --path vendor/bundle - name: Setup environment configuration run: cp .sample.env .env - name: Setup database run: bundle exec rake db:setup - name: Run tests run: bundle exec rake - name: Install appraisal run: bundle exec appraisal install - name: Run appraisal run: bundle exec appraisal rake