Skip to main content
ドキュメントへの更新が頻繁に発行されており、このページの翻訳はまだ行われている場合があります。 最新の情報については、「英語のドキュメント」を参照してください。

GitHub Actions Importer を使った CircleCI からの移行

GitHub Actions Importer を使って、CircleCI パイプラインの GitHub Actions への移行を自動化する方法について説明します。

法的通知

GitHub Actions Importer を使った CircleCI からの移行について

以下の手順では、GitHub Actions Importer を使って CircleCI パイプラインを GitHub Actions に移行するように環境を構成する方法について説明します。

前提条件

  • GitHub Actions ワークフローに変換するプロジェクトとパイプラインを持つ CircleCI アカウントまたは Organization。

  • アカウントまたは Organization の CircleCI 個人用 API トークンを作成するためのアクセス。

  • Linux ベースのコンテナーを実行し、必要なツールをインストールできる環境。

    : GitHub Actions Importer コンテナーと CLI は、CI プラットフォームと同じサーバーにインストールする必要はありません。

制限事項

GitHub Actions Importer を使って CircleCI から GitHub Actions に移行する場合、いくつかの制限があります。

  • 異なるワークフローのジョブ間での自動キャッシュはサポートされていません。
  • audit コマンドは、組織アカウントを使っている場合にのみサポートされます。 ただし、dry-run コマンドと migrate コマンドは、組織またはユーザー アカウントで使うことができます。

手動タスク

特定の CircleCI 構成は手動で移行する必要があります。 具体的な内容は次のとおりです。

  • コンテキスト
  • プロジェクト レベルの環境変数
  • 不明なジョブ プロパティ
  • 不明な orb

GitHub Actions Importer CLI 拡張機能のインストール

  1. GitHub Actions Importer CLI 拡張機能のインストール

    Shell
    gh extension install github/gh-actions-importer
  2. 拡張機能がインストールされていることを確認します。

    $ gh actions-importer -h
    Options:
      -?, -h, --help  Show help and usage information
    
    Commands:
      update     Update to the latest version of GitHub Actions Importer.
      version    Display the version of GitHub Actions Importer.
      configure  Start an interactive prompt to configure credentials used to authenticate with your CI server(s).
      audit      Plan your CI/CD migration by analyzing your current CI/CD footprint.
      forecast   Forecast GitHub Actions usage from historical pipeline utilization.
      dry-run    Convert a pipeline to a GitHub Actions workflow and output its yaml file.
      migrate    Convert a pipeline to a GitHub Actions workflow and open a pull request with the changes.
    

資格情報の構成

configure CLI コマンドを使って、CircleCI と GitHub を操作するときに GitHub Actions Importer に必要な資格情報とオプションを設定します。

  1. GitHub personal access token を作成します。 詳しくは、「個人用アクセス トークンの作成」を参照してください。

    トークンには、workflow スコープが必要です。

    トークンは、作成後にコピーして、後で使用できるように安全な場所に保存します。

  2. CircleCI 個人用 API トークンを作成します。 詳しくは、CircleCI ドキュメントの「API トークンの管理」を参照してください。

    トークンは、作成後にコピーして、後で使用できるように安全な場所に保存します。

  3. ターミナルで、GitHub Actions Importer configure CLI コマンドを実行します。

    gh actions-importer configure

    configure コマンドでは、次の情報の入力が求められます。

    • "どの CI プロバイダーを構成していますか?" で、方向キーを使って CircleCI を選び、Space キーを押して選択し、Enter キーを押します。
    • "GitHub の Personal access token" で、先ほど作成した personal access token の値を入力し、Enter キーを押します。
    • "GitHub インスタンスのベース URL" で、enter the URL for your GitHub Enterprise Server インスタンスの URL を入力し、Enter キーを押します。
    • "CircleCI の Personal access token" で、先ほど作成した CircleCI 個人用 API トークンの値を入力し、Enter キーを押します。
    • "CircleCI インスタンスのベース URL" で、Enter キーを押して既定値 (https://circleci.com) を受け入れます。
    • "CircleCI Organization 名" で、CircleCI Organization の名前を入力し、Enter キーを押します。

    以下に configure コマンドの例を示します。

    $ gh actions-importer configure 
    ✔ Which CI providers are you configuring?: CircleCI
    Enter the following values (leave empty to omit):
    ✔ Personal access token for GitHub: ***************
    ✔ Base url of the GitHub instance: https://github.com
    ✔ Personal access token for CircleCI: ********************
    ✔ Base url of the CircleCI instance: https://circleci.com
    ✔ CircleCI organization name: mycircleciorganization
    Environment variables successfully updated.
  4. ターミナルで GitHub Actions Importer update CLI コマンドを実行して GitHub Packages Container registry に接続し、コンテナー イメージが確実に最新バージョンに更新されるようにします。

    gh actions-importer update

    コマンドの出力は次のようになります。

    Updating ghcr.io/actions-importer/cli:latest...
    ghcr.io/actions-importer/cli:latest up-to-date

CircleCI の監査を実行する

audit コマンドを使って、CircleCI Organization 内のすべてのプロジェクトの概要ビューを取得できます。

audit コマンドによって、次のステップが実行されます。

  1. CircleCI Organization で定義されているすべてのプロジェクトをフェッチします。
  2. 各パイプラインを、対応する GitHub Actions ワークフローに変換します。
  3. GitHub Actions Importer を使って、どの程度完全で複雑な移行が可能かをまとめたレポートを生成します。

監査コマンドの実行

CircleCI Organization の監査を実行するには、ターミナルで次のコマンドを実行します。

gh actions-importer audit circle-ci --output-dir tmp/audit

監査結果の検査

監査の結果は、指定した出力ディレクトリ内のファイルに含まれます。 監査結果の概要については、audit_summary.md ファイルを参照してください。

監査の概要には、次のセクションがあります。

Pipelines

"パイプライン" セクションには、GitHub Actions Importer によって行われた変換率に関する統計情報の概要が含まれます。

以下に、"パイプライン" セクションに表示される可能性がある主な用語を示します。

  • 成功したパイプラインでは、100% のパイプライン構成と個々の項目が、同等の GitHub Actions に自動的に変換されました。
  • 部分的に成功したパイプラインは、すべてのパイプライン構成が変換されましたが、同等の GitHub Actions に自動的に変換されなかった個別項目がいくつかあります。
  • 失敗したパイプラインは、変換中に致命的なエラーが発生しました。 これは、次の 3 つの理由のいずれかで発生する可能性があります。
    • パイプラインが正しく構成されず、CircleCI で有効でなかった。
    • 変換時に GitHub Actions Importer で内部エラーが発生した。
    • ネットワーク応答が失敗して、パイプラインにアクセスできなくなったが、これは多くの場合、無効な資格情報が原因である。

ビルド ステップ

"ビルド ステップ" セクションには、すべてのパイプラインで使われる個々のビルド ステップの概要と、GitHub Actions Importer によって自動的に変換された数が含まれます。

以下に、"ビルド ステップ" セクションに表示される可能性がある主な用語を示します。

  • 既知のビルド ステップは、同等のアクションに自動的に変換されたステップです。
  • 不明なビルド ステップは、同等のアクションに自動的に変換されなかったステップです。
  • 未サポートのビルド ステップは、次のいずれかのステップです。
    • GitHub Actions で基本的にサポートされていない。
    • GitHub Actions と互換性のない方法で構成されている。
  • アクションは、変換されたワークフローで使われたアクションのリストです。 これは、次の場合に重要である可能性があります。
    • GitHub Enterprise Server を使う場合、インスタンスに同期するアクションのリストを収集する。
    • 使われるアクションの組織レベルの許可リストを定義する。 このアクション リストは、セキュリティ チームまたはコンプライアンス チームの確認を必要とする可能性があるアクションの包括的なリストです。

手動タスク

"手動タスク" セクションには、GitHub Actions Importer で自動的に完了できず、手動で完了する必要があるタスクの概要が含まれます。

以下に、"手動タスク" セクションに表示される可能性がある主な用語を示します。

  • シークレットは、変換されたパイプラインで使われるリポジトリまたは組織レベルのシークレットです。 これらのパイプラインが正常に機能するためには、これらのシークレットを GitHub Actions で手動で作成する必要があります。 詳しくは、「暗号化されたシークレット」を参照してください。
  • セルフホステッド ランナーとは、変換されたパイプラインで参照されるランナーのラベルのうち、GitHub ホステッド ランナーではないものを指します。 これらのパイプラインを適切に機能させるには、これらのランナーを手動で定義する必要があります。

ファイル

監査レポートの最後のセクションには、監査中にディスクに書き込まれたすべてのファイルのマニフェストが表示されます。

各パイプライン ファイルには、次のようなさまざまなファイルが監査に含まれます。

  • GitHub で定義された元のパイプライン。
  • パイプラインの変換に使われたネットワーク応答のすべて。
  • 変換されたワークフロー ファイル。
  • 失敗したパイプライン変換のトラブルシューティングに使用できるスタック トレース。

さらに、workflow_usage.csv ファイルには、正常に変換された各パイプラインで使われるすべてのアクション、シークレット、ランナーのコンマ区切りのリストが含まれます。 これは、どのワークフローがどのアクション、シークレット、ランナーを使うかを判断するのに役立ち、セキュリティ レビューを実行するのに役立ちます。

潜在的な GitHub Actions の使用状況を予測する

forecast コマンドを使って、CircleCI で完了したパイプライン実行のメトリックを計算することで、潜在的な GitHub Actions の使用状況を予測できます。

forecast コマンドの実行

潜在的な GitHub Actions の使用状況の予測を実行するには、ターミナルで次のコマンドを実行します。 既定では、GitHub Actions Importer による予測レポートに過去 7 日間が含まれます。

gh actions-importer forecast circle-ci --output-dir tmp/forecast_reports

予測レポートの検査

予測の結果は、指定した出力ディレクトリ内の forecast_report.md ファイルに含まれます。

以下に、予測レポートに表示される可能性がある主な用語を示します。

  • ジョブ数は、完了したジョブの合計数です。

  • パイプライン数は、使われた一意のパイプラインの数です。

  • 実行時間は、ランナーがジョブに費やした時間を表します。 このメトリックを使うと、GitHub ホステッド ランナーのコストを計画するのに役立ちます。

    このメトリックは、GitHub Actions に費やすと予想する時間と相関しています。 これは、この時間 (分) に使われるハードウェアによって異なります。 GitHub Actions 料金計算ツールを使って、コストを見積もることができます。

  • キュー時間メトリックは、ランナーが実行できるようになるのを待機するためにジョブが費やした時間を表します。

  • 同時実行ジョブ メトリックは、特定の時点で実行されるジョブの量を表します。 このメトリックを使って、構成する必要があるランナーの数を定義できます。

さらに、これらのメトリックは、CircleCI のランナーの各キューに対して定義されます。 これはホステッド ランナーとセルフホステッド ランナー、またはハイ スペック マシンとロー スペック マシンが混在している場合に特に有用で、異なるタイプのランナーに固有のメトリックを確認できます。

CircleCI パイプラインの dry-run 移行を実行する

dry-run コマンドを使って、CircleCI パイプラインを同等の GitHub Actions ワークフローに変換できます。 dry-run を実行すると、指定したディレクトリに出力ファイルが作成されますが、パイプラインを移行するための pull request は開かれません。

CircleCI プロジェクトを GitHub Actions に移行するドライ ランを実行するには、ターミナルで次のコマンドを実行し、my-circle-ci-project を CircleCI プロジェクトの名前に置き換えます。

gh actions-importer dry-run circle-ci --output-dir tmp/dry-run --circle-ci-project my-circle-ci-project

指定した出力ディレクトリで、ドライ ランのログと変換されたワークフロー ファイルを表示できます。

不明なビルド ステップや部分的に成功したパイプラインなど、GitHub Actions Importer で自動的に変換できなかったものがある場合は、カスタム トランスフォーマーを作成して変換プロセスをさらにカスタマイズできます。 詳しくは、「カスタム トランスフォーマーを使って GitHub Actions Importer を拡張する」を参照してください。

CircleCI パイプラインの運用移行を実行する

migrate コマンドを使って、CircleCI パイプラインを変換し、同等の GitHub Actions ワークフローで pull request を開くことができます。

migrate コマンドの実行

CircleCI パイプラインを GitHub Actions に移行するには、ターミナルで次のコマンドを実行し、target-url 値を GitHub リポジトリの URL に置き換え、my-circle-ci-project を CircleCI プロジェクトの名前に置き換えます。

gh actions-importer migrate circle-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --circle-ci-project my-circle-ci-project

コマンドの出力には、変換されたワークフローをリポジトリに追加する pull request への URL が含まれます。 成功した出力の例は、次のようになります。

$ gh actions-importer migrate circle-ci --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --circle-ci-project my-circle-ci-project
[2022-08-20 22:08:20] Logs: 'tmp/migrate/log/actions-importer-20220916-014033.log'
[2022-08-20 22:08:20] Pull request: 'https://github.com/octo-org/octo-repo/pull/1'

pull request の検査

migrate コマンドが正常に実行された場合、出力には、変換されたワークフローをリポジトリに追加する新しい pull request へのリンクが含まれます。

pull request の重要な要素には、次のようなものがあります。

  • pull request の説明の「手動ステップ」というセクションには、パイプラインの GitHub Actions への移行を終了する前に手動で完了する必要があるステップが列挙されています。 たとえば、このセクションでは、ワークフローで使われるシークレットを作成するように指示する場合があります。
  • 変換されたワークフロー ファイル。 pull request の [変更されたファイル] タブを選んで、GitHub Enterprise Server リポジトリに追加されるワークフロー ファイルを表示します。

pull request の検査が終了したら、それをマージして、ワークフローを GitHub Enterprise Server リポジトリに追加できます。

リファレンス

このセクションには、環境変数、省略可能な引数、および GitHub Actions Importer を使って CircleCI から移行するときにサポートされる構文に関する参照情報が記載されています。

構成環境変数

GitHub Actions Importer では、認証構成に環境変数が使われます。 これらの変数は、configure コマンドを使って構成プロセスに従うことで設定します。 詳しくは、GitHub Actions Importer の資格情報の構成に関するセクションを参照してください。

GitHub Actions Importer では、次の環境変数を使って CircleCI インスタンスに接続されます。

  • GITHUB_ACCESS_TOKEN: 変換されたワークフローで pull request を作成するために使われる personal access token (repoworkflow スコープが必要)。
  • GITHUB_INSTANCE_URL: ターゲット GitHub インスタンスへの URL (例: https://github.com)。
  • CIRCLE_CI_ACCESS_TOKEN: CircleCI インスタンスで認証するために使われる CircleCI 個人用 API トークン。
  • CIRCLE_CI_INSTANCE_URL: CircleCI インスタンスの URL (例: https://circleci.com)。 変数が未設定のままの場合は、https://circleci.com が既定値として使われます。
  • CIRCLE_CI_ORGANIZATION: CircleCI インスタンスの Organization 名。
  • CIRCLE_CI_PROVIDER: パイプラインのソース ファイルが格納されている場所 (github など)。 現在、GitHub のみがサポートされています。
  • CIRCLE_CI_SOURCE_GITHUB_ACCESS_TOKEN (省略可能): ソースの GitHub インスタンスで認証するために使われる personal access token (repo スコープが必要)。 指定しないと、代わりに GITHUB_ACCESS_TOKEN の値が使われます。
  • CIRCLE_CI_SOURCE_GITHUB_INSTANCE_URL (省略可能): ソース GitHub インスタンスへの URL。 指定しないと、代わりに GITHUB_INSTANCE_URL の値が使われます。

これらの環境変数は、実行時に GitHub Actions Importer によって読み込まれる .env.local ファイルに指定できます。

省略可能な引数。

GitHub Actions Importer サブコマンドと一緒に使って、移行をカスタマイズできる省略可能な引数があります。

--source-file-path 引数は、forecastdry-run、または migrate サブコマンドと一緒に使うことができます。

既定では、GitHub Actions Importer はパイプラインの内容をソース管理からフェッチします。 --source-file-path 引数を指定して、指定したソース ファイル パスを代わりに使うように GitHub Actions Importer に指示します。

次に例を示します。

gh actions-importer dry-run circle-ci --output-dir ./output/ --source-file-path ./path/to/.circleci/config.yml

forecast サブコマンドの実行時に複数のソース ファイルを指定する場合は、ファイル パス値でパターン マッチングを使うことができます。 たとえば、gh forecast --source-file-path ./tmp/previous_forecast/jobs/*.json は、./tmp/previous_forecast/jobs/*.json ファイル パスに一致するすべてのソース ファイルを GitHub Actions Importer に提供します。

--config-file-path

--config-file-path 引数は、auditdry-run、および migrate サブコマンドと一緒に使うことができます。

既定では、GitHub Actions Importer はパイプラインの内容をソース管理からフェッチします。 --config-file-path 引数を指定して、指定したソース ファイルを代わりに使うように GitHub Actions Importer に指示します。

--config-file-path 引数を使って、変換された複合アクションを移行するリポジトリを指定することもできます。

Audit の例

この例では、GitHub Actions Importer で、指定した YAML 構成ファイルを使い、監査が実行されます。

gh actions-importer audit circle-ci --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml

構成ファイルを使って CircleCI インスタンスを監査するには、構成ファイルが次の形式である必要があり、repository_slug がそれぞれ一意である必要があります。

source_files:
  - repository_slug: circle-org-name/circle-project-name
    path: path/to/.circleci/config.yml
  - repository_slug: circle-org-name/some-other-circle-project-name
    path: path/to/.circleci/config.yml
ドライ ランの例

この例では、GitHub Actions Importer で、指定した YAML をソース ファイルとして使い、ドライ ランが実行されます。

構成ファイルの repository_slug--circle-ci-organization および --circle-ci-project オプションの値に一致させてパイプラインを選びます。 次に path を使って、指定したソース ファイルをプルします。

gh actions-importer dry-run circle-ci --circle-ci-project circle-org-name/circle-project-name --output-dir ./output/ --config-file-path ./path/to/circle-ci/config.yml 
変換された複合アクションのリポジトリを指定する

GitHub Actions Importer では --config-file-path 引数に指定された YAML ファイルを使って、変換された複合アクションが移行されるリポジトリを決定します。

まず、--config-file-path 引数を指定せずに監査を実行する必要があります。

gh actions-importer audit circle-ci --output-dir ./output/

このコマンドの出力には、config.yml というファイルが含まれます。これには、GitHub Actions Importer によって変換されたすべての複合アクションの一覧が含まれます。 たとえば、config.yml ファイルの内容は次のようになります。

composite_actions:
  - name: my-composite-action.yml
    target_url: https://github.com/octo-org/octo-repo
    ref: main

このファイルを使って、再利用可能なワークフローまたは複合アクションを追加するリポジトリと参照先を指定できます。 その後、--config-file-path 引数を使って GitHub Actions Importer に config.yml ファイルを指定できます。 たとえば、migrate コマンドを実行するときにこのファイルを使って、構成ファイルで定義されている一意のリポジトリごとに pull request を開くことができます。

gh actions-importer migrate circle-ci --circle-ci-project my-project-name --output-dir output/ --config-file-path config.yml --target-url https://github.com/my-org/my-repo

--include-from

--include-from 引数は、audit サブコマンドと一緒に使うことができます。

--include-from 引数には、CircleCI Organization の監査に含めるリポジトリの行区切りリストを含むファイルを指定します。 このファイルに含まれていないリポジトリはすべて、監査から除外されます。

次に例を示します。

gh actions-importer audit circle-ci --output-dir ./output/ --include-from repositories.txt

このパラメーターに指定するファイルは、リポジトリの行区切りリストである必要があります。次に例を示します。

repository_one
repository_two
repository_three

CircleCI パイプラインでサポートされている構文

次の表は、GitHub Actions Importer で現在変換できるプロパティの種類を示しています。

CircleCI パイプラインGitHub のアクションStatus
cron トリガー
  • on.schedule
サポートされています
環境
  • env
  • jobs.<job_id>.env
  • jobs.<job_id>.steps.env
サポートされています
executors
  • runs-on
サポートされています
jobs
  • jobs
サポートされています
ジョブ (job)
  • jobs.<job_id>
  • jobs.<job_id>.name
サポートされています
マトリックス
  • jobs.<job_id>.strategy
  • jobs.<job_id>.strategy.matrix
サポートされています
parameters
  • env
  • workflow-dispatch.inputs
サポートされています
steps
  • jobs.<job_id>.steps
サポートされています
該当する場合、除外
  • jobs.<job_id>.if
サポートされています
トリガー
  • on
サポートされています
executors
  • container
  • services
部分的にサポートされる
orb
  • actions
部分的にサポートされる
executors
  • self hosted runners
サポートされていない
セットアップ適用なしサポートされていない
version適用なしサポートされていない

サポートされている CircleCI の概念と orb マッピングについて詳しくは、github/gh-actions-importer リポジトリを参照してください。

環境変数のマッピング

GitHub Actions Importer では、次の表のマッピングを使って、既定の CircleCI 環境変数を GitHub Actions の最も近い同等の変数に変換します。

CircleCIGitHub のアクション
CI$CI
CIRCLE_BRANCH${{ github.ref }}
CIRCLE_JOB${{ github.job }}
CIRCLE_PR_NUMBER${{ github.event.number }}
CIRCLE_PR_REPONAME${{ github.repository }}
CIRCLE_PROJECT_REPONAME${{ github.repository }}
CIRCLE_SHA1${{ github.sha }}
CIRCLE_TAG${{ github.ref }}
CIRCLE_USERNAME${{ github.actor }}
CIRCLE_WORKFLOW_ID${{ github.run_number }}
CIRCLE_WORKING_DIRECTORY${{ github.workspace }}
<< pipeline.id >>${{ github.workflow }}
<< pipeline.number >>${{ github.run_number }}
<< pipeline.project.git_url >>$GITHUB_SERVER_URL/$GITHUB_REPOSITORY
<< pipeline.project.type >>github
<< pipeline.git.tag >>${{ github.ref }}
<< pipeline.git.branch >>${{ github.ref }}
<< pipeline.git.revision >>${{ github.event.pull_request.head.sha }}
<< pipeline.git.base_revision >>${{ github.event.pull_request.base.sha }}

法的通知

MIT ライセンスのもとで https://github.com/github/gh-actions-importer/ から一部を引用しています。

MIT License

Copyright (c) 2022 GitHub

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.