カスタムトランスフォーマーを使用した GitHub Actions Importer の拡張

カスタムトランスフォーマーについて

GitHub Actions Importer は、カスタムトランスフォーマーを作成することで、組み込みのマッピングを拡張する機能を提供します。カスタムトランスフォーマーを使うと、次のことができます。

自動的に変換されない GitHub Actions Importer 項目を変換したり、項目の変換方法を変更したりします。詳細については、「項目のカスタムトランスフォーマーの作成」を参照してください。
ランナーへの参照を変えて、異なるランナーラベルを使用する。詳細については、「ランナーのカスタムトランスフォーマーの作成」を参照してください。
環境変数の値を既存のパイプラインから GitHub Actions ワークフローに変換します。詳細については、「環境変数のカスタムトランスフォーマーの作成」を参照してください。

GitHub Actions Importer でカスタムトランスフォーマーを使用する

カスタムトランスフォーマーには、 GitHub Actions Importer プラグイン、タスク、ランナーラベル、または環境変数を変換して GitHub Actionsを操作するために使用できるマッピングロジックが含まれています。カスタムトランスフォーマーは、Ruby に基づいて構築されるドメイン固有言語 (DSL) を使って記述され、.rb ファイル拡張子を持つファイル内で定義されます。

--custom-transformers CLI オプションを使うと、audit、dry-run、migrate コマンドで使うカスタムトランスフォーマーファイルを指定できます。

たとえば、カスタムトランスフォーマーが transformers.rb という名前のファイルで定義されている場合は、次のコマンドを使用して、 GitHub Actions Importerで使用できます。

gh actions-importer ... --custom-transformers transformers.rb

または、glob パターン構文を使って、複数のカスタムトランスフォーマーファイルを指定することもできます。たとえば、 transformersという名前のディレクトリ内に複数のカスタムトランスフォーマーファイルがある場合は、次のコマンドを使用して、すべてを GitHub Actions Importer できます。

gh actions-importer ... --custom-transformers transformers/*.rb

メモ

カスタムトランスフォーマーを使う場合、そのカスタムトランスフォーマーのファイルは、gh actions-importer コマンドの実行元と同じディレクトリ、またはサブディレクトリ内に存在している必要があります。

アイテムのカスタムトランスフォーマーの作成

既存のビルドステップまたはトリガーを GitHub Actions Importer 内の対応するビルドステップまたはトリガーに変換するときに GitHub Actions が使用するカスタムトランスフォーマーを作成できます。これは、次の場合に特に便利です。

GitHub Actions Importer は項目を自動的に変換しません。
GitHub Actions Importerによって項目を変換する方法を変更する必要があります。
既存のパイプラインでは、Jenkins の共有ライブラリなどのカスタムまたは独自の拡張機能が使用されるため、 GitHub Actionsでこれらの手順がどのように機能するかを定義する必要があります。

GitHub Actions Importer では、Ruby 上に構築された DSL を使用して定義されたカスタムトランスフォーマーが使用されます。ビルドステップとトリガー用のカスタムトランスフォーマーを作成するには:

各カスタムトランスフォーマーファイルには、少なくとも 1 つの transform メソッドを含める必要があります。
各 transform メソッドは、Hash、Hash の配列、または nil を返す必要があります。この戻り値は、YAML で定義されているアクションに対応します。アクションの詳細については、「GitHub Actionsについて」を参照してください。

ビルドステップ用のカスタムトランスフォーマーの例

次の例では、"buildJavaScriptApp" 識別子を使うビルドステップを変換して、さまざまな npm コマンドを実行します。

Ruby

transform "buildJavaScriptApp" do |item|
  command = ["build", "package", "deploy"].map do |script|
    "npm run #{script}"
  end

  {
    name: "build javascript app",
    run: command.join("\n")
  }
end

transform "buildJavaScriptApp" do |item|
  command = ["build", "package", "deploy"].map do |script|
    "npm run #{script}"
  end

  {
    name: "build javascript app",
    run: command.join("\n")
  }
end

上記の例では、次の GitHub Actions ワークフローステップが作成されます。これは、変換済みの buildJavaScriptApp 識別子を持っていたビルドステップで構成されています。

- name: build javascript app
  run: |
    npm run build
    npm run package
    npm run deploy

transform メソッドでは、ソース CI/CD インスタンスのビルドステップの識別子を引数で使用します。この例では、識別子は buildJavaScriptLibrary です。コンマ区切りの値を使って、複数の識別子を transform メソッドに渡すこともできます。たとえば、「 transform "buildJavaScriptApp", "buildTypeScriptApp" { |item| ... } 」のように入力します。

メモ

item のデータ構造は、CI/CD プラットフォームと変換される項目の種類によって異なります。

ランナーのカスタムトランスフォーマーの作成

ソース CI/CD インスタンス内のランナーと、それに対応する GitHub Actions ランナーとの対応付けをカスタマイズできます。

GitHub Actions Importer では、Ruby 上に構築された DSL を使用して定義されたカスタムトランスフォーマーが使用されます。ランナー用のカスタムトランスフォーマーを作成するには:

カスタムトランスフォーマーファイルには、少なくとも 1 つの runner メソッドを含める必要があります。
runner メソッドには 2 つのパラメーターを指定できます。最初のパラメーターはソース CI/CD インスタンスのランナーラベルで、2 番目のパラメーターは対応する GitHub Actions ランナーラベルです。 GitHub Actions ランナーの詳細については、「GitHub ホステッドランナー」を参照してください。

ランナー用カスタムトランスフォーマーの例

次の例は、結果のワークフローで 1 つのランナーラベルを 1 つのrunner ランナーラベルに変換するGitHub Actions メソッドを示しています。

Ruby

runner "linux", "ubuntu-latest"

runner "linux", "ubuntu-latest"

runner メソッドを使用して、結果のワークフローで 1 つのランナーラベルを複数のGitHub Actionsランナーラベルに変換することもできます。

Ruby

runner "big-agent", ["self-hosted", "xl", "linux"]

runner "big-agent", ["self-hosted", "xl", "linux"]

GitHub Actions Importer は、ランナーラベルを可能な限りマップしようとします。それができない場合は、ubuntu-latest ランナーラベルが既定値として使用されます。 runner メソッドで特別なキーワードを使うと、この既定値を制御できます。たとえば、次のカスタムトランスフォーマーは、GitHub Actions Importerの代わりに既定のランナーとしてmacos-latestを使用するようにubuntu-latestに指示します。

Ruby

runner :default, "macos-latest"

runner :default, "macos-latest"

環境変数のカスタムトランスフォーマーの作成

ソース CI/CD パイプライン内の環境変数間のマッピングを、 GitHub Actions内の値にカスタマイズできます。

GitHub Actions Importer では、Ruby 上に構築された DSL を使用して定義されたカスタムトランスフォーマーが使用されます。環境変数のカスタムトランスフォーマーを作成するには:

カスタムトランスフォーマーファイルには、少なくとも 1 つの env メソッドを含める必要があります。
env メソッドには 2 つのパラメーターを指定できます。最初のパラメーターは元のパイプラインの環境変数の名前で、2 番目のパラメーターは GitHub Actionsの環境変数の更新された値です。 GitHub Actions環境変数の詳細については、変数に情報を格納するを参照してください。

環境変数のカスタムトランスフォーマーの例

環境変数をマップするカスタムトランスフォーマーを設定するには、いくつかの方法があります。

次の例では、OCTO という名前の既存の環境変数の値を、パイプラインの変換時に CAT に設定します。
Ruby
```
env "OCTO", "CAT"
```
```
env "OCTO", "CAT"
```
特定の環境変数のすべてのインスタンスを削除して、 GitHub Actions ワークフローに変換されないようにすることもできます。次の例では、MONA_LISA という名前のすべての環境変数を削除します。
Ruby
```
env "MONA_LISA", nil
```
```
env "MONA_LISA", nil
```
既存の環境変数をシークレットにマップすることもできます。たとえば、次の env メソッドは、MONALISA という名前の環境変数を OCTOCAT という名前のシークレットにマップします。
Ruby
```
env "MONALISA", secret("OCTOCAT")
```
```
env "MONALISA", secret("OCTOCAT")
```
これにより、変換されたワークフローでは OCTOCAT という名前のシークレットへの参照が設定されます。シークレットを機能させるには、GitHub リポジトリにシークレットを作成する必要があります。詳しくは、「GitHub Actions でのシークレットの使用」をご覧ください。
正規表現を使って、複数の環境変数の値を一度に更新することもできます。たとえば、次のカスタムトランスフォーマーでは、変換されたワークフローからすべての環境変数を削除します。
Ruby
```
env /.*/, nil
```
```
env /.*/, nil
```
次の例では、正規表現の一致グループを使って、環境変数の値を動的に生成されたシークレットに変換します。
Ruby
```
env /^(.+)_SSH_KEY/, secret("%s_SSH_KEY)
```
```
env /^(.+)_SSH_KEY/, secret("%s_SSH_KEY)
```
メモ

各 env メソッドを定義する順序は、正規表現を使う場合に重要となります。環境変数名と一致する最初の env トランスフォーマーは、後続の env メソッドよりも優先されます。最も具体的な環境変数のトランスフォーマーを最初に定義する必要があります。

法務上の通知

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.

カスタム トランスフォーマーを使用した GitHub Actions Importer の拡張

この記事で

カスタムトランスフォーマーを使用した GitHub Actions Importer の拡張