GitHub Actions Importer を使用したAzure DevOpsからの移行

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

この記事で

GitHub Actions Importer を使用したAzure DevOpsからの移行について

次の手順では、GitHub Actions Importerを使用してAzure DevOpsパイプラインをGitHub Actionsに移行するように環境を構成する手順について説明します。

前提条件

  • GitHub Actions ワークフローに変換するプロジェクトとパイプラインを含むAzure DevOpsアカウントまたは組織。
  • アカウントまたは組織向けの Azure DevOps personal access token を作成するためのアクセス許可。
  • Linux ベースのコンテナーを実行し、必要なツールをインストールできる環境。

    メモ

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

制限事項

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

  • GitHub Actions Importerには、Azure DevOps API のバージョン 5.0 が必要です。Azure DevOps サービスまたは Azure DevOps Server 2019 で使用できます。 以前のバージョンのAzure DevOps Serverには互換性がありません。
  • ソース コードのチェックアウトなど、Azure DevOps パイプラインに暗黙的に追加されるタスクは、GUID 名としてGitHub Actions Importer監査に追加できます。 GUID のフレンドリ タスク名を見つけるには、URL https://dev.azure.com/:organization/_apis/distributedtask/tasks/:guid を使用できます。

手動タスク

特定のAzure DevOpsコンストラクトは、Azure DevOpsからGitHub Actions構成に手動で移行する必要があります。 具体的な内容は次のとおりです。

  • 組織、リポジトリ、環境のシークレット
  • OIDC Connect、GitHub Apps、personal access tokens などのサービス接続
  • 不明なタスク
  • セルフホステッド エージェント (自己ホスト型エージェント)
  • 環境
  • デプロイ前の承認

手動移行の詳細については、「Azure Pipelines から GitHub Actions への移行」を参照してください。

サポート対象外のタスク

GitHub Actions Importer では、次のタスクの移行はサポートされていません。

  • デプロイ前ゲート
  • デプロイ後のゲート
  • デプロイ後の承認
  • いくつかのリソース トリガー

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

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

    Bash
    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 コマンドを使用して、Azure DevOpsとGitHub Actions Importerを操作するときにGitHubに必要な資格情報とオプションを設定します。

  1. GitHub personal access token (classic)を作成します。 詳しくは、「個人用アクセス トークンを管理する」をご覧ください。

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

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

  2. Azure DevOps personal access tokenを作成します。 詳細については、Azure DevOpsドキュメントの「personal access tokensを使用する」を参照してください。 トークンには次のスコープが必要です。

    • エージェント プール: Read
    • ビルド: Read
    • コード: Read
    • リリース: Read
    • サービス接続: Read
    • タスク グループ: Read
    • 変数グループ: Read

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

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

    gh actions-importer configure

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

  • [どの CI プロバイダーを構成していますか?] で、方向キーを使用して Azure DevOps を選択し、Space キーを押して選択し、Enter キーを押します。
  • [Personal access token for GitHub] に、先ほど作成した personal access token (classic) の値を入力し、 Enter キーを押します。
  • [GitHub インスタンスのベース URL] で、 キーを押します。Enter キーを押して既定値 (https://github.com) をそのまま使用します。
  • [Azure DevOpsのPersonal access token] に、先ほど作成したAzure DevOps personal access tokenの値を入力し、Enter キーを押します。
  • [Azure DevOps インスタンスのベース URL] で、Enter キーを押して既定値 (https://dev.azure.com) を受け入れます。
  • [Azure DevOps組織名] に、Azure DevOps組織の名前を入力し、Enter キーを押します。
  • [Azure DevOps プロジェクト名] に、Azure DevOps プロジェクトの名前を入力し、Enter キーを押します。

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

$ gh actions-importer configure
✔ Which CI providers are you configuring?: Azure DevOps
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 Azure DevOps: ***************
✔ Base url of the Azure DevOps instance: https://dev.azure.com
✔ Azure DevOps organization name: :organization
✔ Azure DevOps project name: :project
Environment variables successfully updated.

  1. ターミナルで、 GitHub Actions Importerupdate CLI コマンドを実行して GitHub PackagesContainer registry に接続し、コンテナー イメージが最新バージョンに更新されていることを確認します。

    gh actions-importer update

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

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

Azure DevOpsの監査を実行する

audit コマンドを使用すると、Azure DevOps組織内のすべてのプロジェクトの概要を確認できます。

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

  1. Azure DevOps組織で定義されているすべてのプロジェクトを取得します。
  2. 各パイプラインを、同等の GitHub Actions ワークフローに変換します。
  3. GitHub Actions Importerを使用して移行の完了と複雑さを要約したレポートを生成します。

監査コマンドの実行

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

gh actions-importer audit azure-devops --output-dir tmp/audit

監査結果の検査

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

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

Pipelines

"Pipelines" セクションには、 GitHub Actions Importerによって行われた変換率に関する高レベルの統計情報が含まれています。

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

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

ビルド ステップ

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

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

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

手動タスク

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

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

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

Files

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

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

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

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

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

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

forecast コマンドの実行

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

gh actions-importer forecast azure-devops --output-dir tmp/forecast_reports

予測レポートの検査

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

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

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

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

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

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

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

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

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

dry-run による移行を実行する

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

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

ビルド パイプラインの dry-run コマンドの実行

Azure DevOps ビルド パイプラインを GitHub Actions に移行するドライ ランを実行するには、ターミナルで次のコマンドを実行し、pipeline_idを変換するパイプラインの ID に置き換えます。

gh actions-importer dry-run azure-devops pipeline --pipeline-id :pipeline_id --output-dir tmp/dry-run

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

リリース パイプラインの dry-run コマンドの実行

Azure DevOps リリース パイプラインを GitHub Actions に移行するドライ ランを実行するには、ターミナルで次のコマンドを実行し、pipeline_idを変換するパイプラインの ID に置き換えます。

gh actions-importer dry-run azure-devops release --pipeline-id :pipeline_id --output-dir tmp/dry-run

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

運用環境の移行を実行する

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

ビルド パイプラインの migrate コマンドの実行

Azure DevOpsビルド パイプラインをGitHub Actionsに移行するには、ターミナルで次のコマンドを実行し、target-urlの値をGitHub リポジトリの URL に置き換え、変換するパイプラインの ID にpipeline_idします。

gh actions-importer migrate azure-devops pipeline --pipeline-id :pipeline_id --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate

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

$ gh actions-importer migrate azure-devops pipeline --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --azure-devops-project my-azure-devops-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'

リリース パイプラインの migrate コマンドの実行

Azure DevOpsリリース パイプラインをGitHub Actionsに移行するには、ターミナルで次のコマンドを実行し、target-urlの値をGitHub リポジトリの URL に置き換え、変換するパイプラインの ID でpipeline_idします。

gh actions-importer migrate azure-devops release --pipeline-id :pipeline_id --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate

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

$ gh actions-importer migrate azure-devops release --target-url https://github.com/octo-org/octo-repo --output-dir tmp/migrate --azure-devops-project my-azure-devops-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 の [Files changed] タブを選んで、GitHub リポジトリに追加されるワークフロー ファイルを表示します。

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

リファレンス

このセクションでは、GitHub Actions Importerを使用してAzure DevOpsから移行する場合の環境変数、省略可能な引数、およびサポートされる構文に関する参照情報について説明します。

構成環境変数

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

GitHub Actions Importerでは、次の環境変数を使用して Azure DevOps インスタンスに接続します。

  • GITHUB_ACCESS_TOKEN: 変換されたワークフローを使用してプル要求を作成するために使用される personal access token (classic) ( workflow スコープが必要です)。
  • GITHUB_INSTANCE_URL: ターゲット GitHub インスタンスへの URL (たとえば、 https://github.com)。
  • AZURE_DEVOPS_ACCESS_TOKEN: Azure DevOps インスタンスでの認証に使用されるpersonal access token。 このトークンには、次のスコープが必要です。
    • ビルド: Read
    • エージェント プール: Read
    • コード: Read
    • リリース: Read
    • サービス接続: Read
    • タスク グループ: Read
    • 変数グループ: Read
  • AZURE_DEVOPS_PROJECT: パイプラインの移行時に使うプロジェクト名または GUID。 すべてのプロジェクトに対して監査を実行する場合、これは省略可能です。
  • AZURE_DEVOPS_ORGANIZATION: Azure DevOps インスタンスの組織名。
  • AZURE_DEVOPS_INSTANCE_URL: https://dev.azure.com など、Azure DevOps インスタンスへの URL。

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

省略可能な引数。

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

--source-file-path

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

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

次に例を示します。

gh actions-importer dry-run azure-devops pipeline --output-dir ./output/ --source-file-path ./path/to/azure_devops/pipeline.yml

--config-file-path

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

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

--config-file-path 引数を使って、変換された再利用可能なワークフローまたは複合アクションを移行するリポジトリを指定することもできます。

監査の例

この例では、 GitHub Actions Importer は、指定した YAML 構成ファイルをソース ファイルとして使用して監査を実行します。

gh actions-importer audit azure-devops pipeline --output-dir ./output/ --config-file-path ./path/to/azure_devops/config.yml

構成ファイルを使用してAzure DevOps インスタンスを監査するには、構成ファイルが次の形式で、各repository_slugが一意である必要があります。

source_files:
  - repository_slug: azdo-project/1
    path: file.yml
  - repository_slug: azdo-project/2
    paths: path.yml

Azure DevOps組織名、プロジェクト名、およびパイプライン ID を組み合わせることで、パイプラインのrepository_slugを生成できます。 たとえば、「 my-organization-name/my-project-name/42 」のように入力します。

ドライ ランの例

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

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

gh actions-importer dry-run azure-devops pipeline --output-dir ./output/ --config-file-path ./path/to/azure_devops/config.yml
変換された再利用可能なワークフローと複合アクションのリポジトリを指定する

GitHub Actions Importer は、 --config-file-path 引数に指定された YAML ファイルを使用して、再利用可能なワークフローと複合アクションを変換したリポジトリを決定します。

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

gh actions-importer audit azure-devops --output-dir ./output/

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

reusable_workflows:
  - name: my-reusable-workflow.yml
    target_url: https://github.com/octo-org/octo-repo
    ref: main

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

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

gh actions-importer migrate azure-devops pipeline --config-file-path config.yml --target-url https://github.com/my-org/my-repo

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

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

Azure PipelinesGitHub Actionsステータス
条件
  • jobs.<job_id>.if
  • jobs.<job_id>.steps[*].if
サポートされています
コンテナ
  • jobs.<job_id>.container
  • jobs.<job_id>.name
サポートされています
継続的インテグレーション
  • on.<push>.<branches>
  • on.<push>.<tags>
  • on.<push>.paths
サポートされています
ジョブ
  • jobs.<job_id>
サポートされています
プルリクエスト
  • on.<pull_request>.<branches>
  • on.<pull_request>.paths
サポートされています
ステージ
  • jobs
サポートされています
手順
  • jobs.<job_id>.steps
サポートされています
戦略
  • jobs.<job_id>.strategy.fail-fast
  • jobs.<job_id>.strategy.max-parallel
  • jobs.<job_id>.strategy.matrix
サポートされています
タイムアウト (分)
  • jobs.<job_id>.timeout-minutes
サポートされています
変数
  • env
  • jobs.<job_id>.env
  • jobs.<job_id>.steps.env
サポートされています
手動デプロイ
  • jobs.<job_id>.environment
部分的にサポートされています。
プール
  • runners
  • self hosted runners
部分的にサポートされています。
サービス
  • jobs.<job_id>.services
部分的にサポートされています。
戦略
  • jobs.<job_id>.strategy
部分的にサポートされています。
トリガー
  • on
部分的にサポートされています。
プルリクエスト
  • on.<pull_request>.<tags>
サポートされていない
スケジュール
  • on.schedule
  • on.workflow_run
サポートされていない
トリガー
  • on.<event_name>.types
サポートされていない

サポートされているAzure DevOps タスクの詳細については、github/gh-actions-importer リポジトリを参照してください。

環境変数のマッピング

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

Azure PipelinesGitHub Actions
$(Agent.BuildDirectory)${{ runner.workspace }}
$(Agent.HomeDirectory)${{ env.HOME }}
$(Agent.JobName)${{ github.job }}
$(Agent.OS)${{ runner.os }}
$(Agent.ReleaseDirectory)${{ github.workspace}}
$(Agent.RootDirectory)${{ github.workspace }}
$(Agent.ToolsDirectory)${{ runner.tool_cache }}
$(Agent.WorkFolder)${{ github.workspace }}
$(Build.ArtifactStagingDirectory)${{ runner.temp }}
$(Build.BinariesDirectory)${{ github.workspace }}
$(Build.BuildId)${{ github.run_id }}
$(Build.BuildNumber)${{ github.run_number }}
$(Build.DefinitionId)${{ github.workflow }}
$(Build.DefinitionName)${{ github.workflow }}
$(Build.PullRequest.TargetBranch)${{ github.base_ref }}
$(Build.PullRequest.TargetBranch.Name)${{ github.base_ref }}
$(Build.QueuedBy)${{ github.actor }}
$(Build.Reason)${{ github.event_name }}
$(Build.Repository.LocalPath)${{ github.workspace }}
$(Build.Repository.Name)${{ github.repository }}
$(Build.Repository.Provider)GitHub
$(Build.Repository.Uri)${{ github.server.url }}/${{ github.repository }}
$(Build.RequestedFor)${{ github.actor }}
$(Build.SourceBranch)${{ github.ref }}
$(Build.SourceBranchName)${{ github.ref }}
$(Build.SourceVersion)${{ github.sha }}
$(Build.SourcesDirectory)${{ github.workspace }}
$(Build.StagingDirectory)${{ runner.temp }}
$(Pipeline.Workspace)${{ runner.workspace }}
$(Release.DefinitionEnvironmentId)${{ github.job }}
$(Release.DefinitionId)${{ github.workflow }}
$(Release.DefinitionName)${{ github.workflow }}
$(Release.Deployment.RequestedFor)${{ github.actor }}
$(Release.DeploymentID)${{ github.run_id }}
$(Release.EnvironmentId)${{ github.job }}
$(Release.EnvironmentName)${{ github.job }}
$(Release.Reason)${{ github.event_name }}
$(Release.RequestedFor)${{ github.actor }}
$(System.ArtifactsDirectory)${{ github.workspace }}
$(System.DefaultWorkingDirectory)${{ github.workspace }}
$(System.HostType)build
$(System.JobId)${{ github.job }}
$(System.JobName)${{ github.job }}
$(System.PullRequest.PullRequestId)${{ github.event.number }}
$(System.PullRequest.PullRequestNumber)${{ github.event.number }}
$(System.PullRequest.SourceBranch)${{ github.ref }}
$(System.PullRequest.SourceRepositoryUri)${{ github.server.url }}/${{ github.repository }}
$(System.PullRequest.TargetBranch)${{ github.event.base.ref }}
$(System.PullRequest.TargetBranchName)${{ github.event.base.ref }}
$(System.StageAttempt)${{ github.run_number }}
$(System.TeamFoundationCollectionUri)${{ github.server.url }}/${{ github.repository }}
$(System.WorkFolder)${{ github.workspace }}

テンプレート

GitHub Actions Importerを使用してAzure DevOpsテンプレートを変換できます。

制限事項

GitHub Actions Importer は、いくつかの制限はあるものの、Azure DevOps テンプレートを変換することができます。

  • stages、deployments、およびjobs キーで使用されるAzure DevOps テンプレートは、GitHub Actionsで再利用可能なワークフローに変換されます。 詳しくは、「ワークフローを再利用する」をご覧ください。
  • steps キーで使用されるAzure DevOps テンプレートは複合アクションに変換されます。 詳しくは、「複合アクションを作成する」をご覧ください。
  • 現在、他のジョブ テンプレートを参照するジョブ テンプレートがある場合は、 GitHub Actions Importer テンプレートを再利用可能なワークフローに変換します。 再利用可能なワークフローは他の再利用可能なワークフローを参照できないため、これは GitHub Actionsでは無効な構文です。 入れ子になった再利用可能なワークフローを手動で修正する必要があります。
  • テンプレートが外部Azure DevOps組織またはGitHubリポジトリを参照している場合は、--credentials-file オプションを使用して、このテンプレートにアクセスするための資格情報を指定する必要があります。 詳しくは、「補助的な引数と設定」をご覧ください。
  • each 式を使って YAML を動的に生成できますが、次の注意事項があります。
    • 入れ子になった each ブロックはサポートされていないため、親の each ブロックはサポートされません。
    • each および含まれる if 条件は変換時に評価されます。これは、 GitHub Actions がこのスタイルの挿入をサポートしていないためです。
    • elseif ブロックはサポートされていません。 この機能が必要な場合は、手動で修正する必要があります。
    • 入れ子になった if ブロックはサポートされていますが、if/elseif/else 条件の下で入れ子になった if ブロックはサポートされていません。
    • 定義済みのAzure DevOps変数を使用する if ブロックはサポートされていません。

サポートされているテンプレート

GitHub Actions Importer では、次の表に示すテンプレートがサポートされています。

Azure PipelinesGitHub Actionsステータス
テンプレートからの拡張Reusable workflowサポートされています
ジョブ テンプレートReusable workflowサポートされています
ステージ テンプレートReusable workflowサポートされています
ステップ テンプレートComposite actionサポートされています
クラシック エディターのタスク グループ場合により異なるサポートされています
別のAzure DevOps組織、プロジェクト、またはリポジトリ内のテンプレート場合により異なるサポートされています
GitHub リポジトリ内のテンプレート場合により異なるサポートされています
変数テンプレートenvサポートされています
条件付きの挿入ジョブ/ステップに関するif条件部分的にサポートされています。
反復の挿入適用なし部分的にサポートされています。
パラメーターを含むテンプレート場合により異なる部分的にサポートされています。

テンプレート ファイルのパス名

GitHub Actions Importer では、ファイル名に変数、パラメーター、および反復式を含む相対ファイル パスまたは動的ファイル パスを含むテンプレートを抽出できます。 ただし、既定値が設定されている必要があります。

変数ファイル パス名の例
# File: azure-pipelines.yml
variables:
- template: 'templates/vars.yml'

steps:
- template: "./templates/$"

# File: templates/vars.yml
variables:
  one: 'simple_step.yml'
パラメーター ファイル パス名の例
parameters:
- name: template
  type: string
  default: simple_step.yml

steps:
- template: "./templates/${{ parameters.template }}"
イテラティブファイルパス名の例
parameters:
- name: steps
  type: object
  default:
  - build_step
  - release_step
steps:
- ${{ each step in parameters.steps }}:
    - template: "$-variables.yml"

テンプレート パラメーター

GitHub Actions Importer では、次の表に示すパラメーターがサポートされています。

Azure PipelinesGitHub Actionsステータス
文字列inputs.stringサポートされています
数値inputs.numberサポートされています
booleaninputs.booleanサポートされています
オブジェクト
inputs.string とfromJSON式部分的にサポートされています。
ステップstep部分的にサポートされています。
ステップリストstep部分的にサポートされています。
ジョブjob部分的にサポートされています。
ジョブリストjob部分的にサポートされています。
デプロイjob部分的にサポートされています。
デプロイメントリストjob部分的にサポートされています。
ステージjob部分的にサポートされています。
ステージリストjob部分的にサポートされています。

メモ

このパラメーター型の step キーの下で使用されるテンプレートは、テンプレート ステップの先頭または末尾でステップが使用されている場合にのみ、複合アクションとしてシリアル化されます。 このパラメーター型の stage、deployment、job キーで使われるテンプレートは、再利用可能なワークフローに変換されず、代わりにスタンドアロン ワークフローとしてシリアル化されます。

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.