使用可能な Microsoft Power Platform 開発用 GitHub Actions

次のセクションでは、Microsoft Power PlatformのGitHub Actionsについて説明します。 これらのセクションでは、サンプル GitHub ワークフローも示します。 GitHub Actions とそのダウンロード方法の詳細については、Microsoft Power Platform の GitHub Actionsを参照してください。

Microsoft Power Platform で GitHub Actions で使用する認証情報を構成する

アクションの多くは、Microsoft Dataverse 環境に接続する必要があります。 GitHub リポジトリにサービス プリンシパルまたはユーザー資格情報をシークレットとして追加し、ワークフローで使用します。

  • GitHubでシークレットを設定する方法の詳細については、「暗号化されたシークレット」を参照してください。

  • Microsoft Power Platformのサービス プリンシパル認証を設定する方法の詳細については、DevOps ビルド ツールに関するページを参照してください。

資格情報を構成したら、アクション スクリプト内からサービス プリンシパルを呼び出すことができます。

GitHub アクション スクリプト内で環境変数として次のパラメーターを定義します。

  • アプリケーション ID(例: WF_APPLICATION_ID:<your application id>)
  • テナント ID(例: WF_TENANT_ID:<your tenant id>)

クライアントシークレットをGitHubシークレットとして追加します。 次のようなパラメーターを使用して、ワークフロー内から参照します。 client secret: ${{secrets.CLIENT_SECRET_GITHUB_ACTIONS}}

ヘルパータスク

次のヘルパー タスクを使用できます。

actions-install

GitHub Actions ワークフローがランナーのコンテキストで Power Platform CLI のインストールを強制し、タイムアウト エラーが発生した場合は、次の例に示すように、追加のアクション (actions-install) でバージョン 1 (@v1) を使用します。

重要

  • バージョン 1(@v1)を使用すると、既存の GitHub アクションに更新が行われ、その結果、現在のワークフローが更新される可能性があります。
  • Power Platform 用の他のGitHub Actionsの前に、Power Platform Tools のインストール タスクをワークフローの最初のタスクとして追加してください。
jobs:
    builds:
        runs-on: windows-latest   # alternate runner OS is: ubuntu-latest

    steps:
    - name: Install Power Platform Tools
        uses: microsoft/powerplatform-actions/actions-install@v1

    - name: Export Solution
         uses: microsoft/powerplatform-actions/export-solution@v1
      with:
         environment-url: 'https://myenv.crm.dynamics.com'
         user-name: 'me@myenv.onmicrosoft.com'
         password-secret: ${{ secrets.MYPASSWORD }}
         solution-name: aSolution
         solution-output-file: 'aSolution.zip'
         working-directory: 'out'

GitHub Actionsのその他のサンプルについては、Power Platform Actions を参照してください。

whoAmI

サービスに接続して WhoAmI[SDK/Web API] リクエストを送信することにより、サービス接続を確認します。 このタスクは、処理を開始する前に接続を確認するために、GitHub ワークフローの早い段階で含めると便利です。

パラメーター 説明
environment-url 接続している環境の URL。
user-name 接続に使用しているアカウントのユーザー名
password-secret ユーザー名 のパスワード。 設定 の シークレット で GitHub パスワードを定義します。 定義して保存した後でシークレットを取得することはできません。
app-id 認証に使用するアプリケーション ID。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
client-secret GitHub パイプラインの認証に使用されるクライアント シークレット。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
tenant-id app-id と client-secret を使用した認証時のテナント ID。

ソリューションのタスク

これらのタスクは、ソリューションに対してアクションを実行し、以下が含まれます。

import-solution

ソリューションをターゲット環境にインポートします。

パラメーター 説明
environment-url (必須) ソリューションをインポートするターゲット環境の URL (たとえば、https://YourOrg.crm.dynamics.com)。
user-name (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用しているアカウントのユーザー名。
password-secret (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用しているアカウントのパスワード。
solution-file (必須) インポートするソリューション ファイルのパスと名前。
app-id 認証に使用するアプリケーション ID。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
client-secret GitHub パイプラインの認証に使用されるクライアント シークレット。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
tenant-id app-id と client-secret を使用した認証時のテナント ID。

export-solution

ソース環境からソリューションをエクスポートします。

パラメータ 説明
environment-url (必須) ソリューションのエクスポート元となる環境の URL (たとえば、https://YourOrg.crm.dynamics.com)。
user-name (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用しているアカウントのユーザー名を入力します。
password-secret (必須) ユーザー名/パスワード認証を使用している場合、ユーザー名のパスワード。 設定 の シークレット で GitHub パスワードを定義します。 定義して保存した後でシークレットを取得することはできません。
app-id 認証に使用するアプリケーション ID。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
client-secret GitHub パイプラインの認証に使用されるクライアント シークレット。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
tenant-id app-id と client-secret を使用した認証時のテナント ID。
solution-name (必須) エクスポートを行うソリューションの名称。 常にソリューションの 名前 ではなく、表示名 を使用してください。
solution-output-file (必須) ソース環境のエクスポート先となる solution.zip ファイルのパスと名前。
マネージ (必須) 管理ソリューションとしてエクスポートするには true に設定します。既定 (false) では、アンマネージド ソリューションとしてエクスポートします。

unpack-solution

圧縮されたソリューション ファイルを受け取り、複数の XML ファイルに分解します。 ソース管理システムでは、これらのファイルをより簡単に読み取って管理できます。

パラメータ 説明
solution-file (必須) 解凍をする solution.zip ファイルのパスと名称を指定します。
solution-folder (必須)ソリューションをアンパックする場所となるパスとターゲット フォルダー。
solution-type (必須) 展開するソリューションの種類。 オプションには、アンマネージド(推奨)、マネージド、両方 があります。

pack-solution

ソース管理で表されるソリューションを、別の環境にインポートできる solution.zip ファイルにパックします。

パラメーター 説明
solution-file (必須) ソリューションをパックするための solution.zip ファイルのパスとファイル名 (たとえば、out/CI/ALMLab.zip)。
solution-folder (必須) パッケージ化するソリューションのパスとソース フォルダー。
solution-type (オプション) パックするソリューションの種類。 オプションには、アンマネージド (推奨)、マネージド、両方 があります。

publish-solution

ソリューションのカスタマイズを公開します。

パラメーター 説明
environment-url (必須) ソリューションを公開する環境の URL (たとえば、https://YourOrg.crm.dynamics.com)。
user-name (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用しているアカウントのユーザー名を入力します。
password-secret (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用しているアカウントのパスワードです。
solution-file (必須) インポートするソリューション ファイルのパスと名前。
app-id 認証に使用するアプリケーション ID。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
client-secret GitHub パイプラインの認証に使用されるクライアント シークレット。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
tenant-id app-id と client-secret を使用した認証時のテナント ID。

clone-solution

指定した環境のソリューションを複製します。

パラメーター 説明
environment-url (必須) ソリューションの複製元となる環境の URL (たとえば、https://YourOrg.crm.dynamics.com)。
user-name (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用しているアカウントのユーザー名を入力します。
password-secret (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用しているアカウントのパスワード。
solution-file (必須) インポートするソリューション ファイルのパスと名前。
app-id 認証に使用するアプリケーション ID。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
client-secret GitHub パイプラインの認証に使用されるクライアント シークレット。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
tenant-id app-id と client-secret を使用した認証時のテナント ID。
solution-name (必須) クローンに必要な solution.zip ファイルのパスと名前 (たとえば、out/CI/ALMLab.zip)。
solution-version 複製元のソリューションのバージョン。
target-folder 抽出したソリューションを配置するターゲット フォルダー。 (たとえば、Git repository\target-solution-folder)。
Working-directory ソリューションの複製に必要な作業途中の成果物用一時フォルダー。
既定: root of the repository

解決策を確認

ソリューション ファイルをチェックして、不整合を検出します。

パラメータ 説明
environment-url (必須) ソリューションの複製元となる環境の URL (たとえば、https://YourOrg.crm.dynamics.com)。
user-name (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用しているアカウントのユーザー名。
password-secret (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用しているアカウントのパスワード。
app-id 認証に使用するアプリケーション ID。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
client-secret GitHub パイプラインの認証に使用されるクライアント シークレット。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
tenant-id app-id と client-secret を使用した認証時のテナント ID。
パス (必須) チェックするソリューション ファイルのパスと名前。
geo 使用する Microsoft Power Platform チェッカー サービスの地理的な場所。 既定値は、'united states' です。
rule-level-override ルールとそのレベルの JSON 配列を含むファイルへのパス。 指定できる値は、Critical、High、Low、Informational です。 例: [{"Id":"meta-remove-dup-reg","OverrideLevel":"Medium"},{"Id":"il-avoid-specialized-update-ops","OverrideLevel":"Medium"}]
checker-logs-artifact-name Microsoft Power Platform チェッカー ログがアップロードされるアーティファクト フォルダーの名前。 既定値は 'CheckSolutionLogs' です。

upgrade-solution

ソリューションをアップグレードします。

パラメーター 説明
environment-url (必須) ソリューションの複製元となる環境の URL (たとえば、https://YourOrg.crm.dynamics.com)。
user-name (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用しているアカウントのユーザー名。
password-secret (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用するアカウントのパスワード。
solution-file (必須) インポートするソリューション ファイルのパスと名前。
app-id 認証に使用するアプリケーション ID。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
client-secret GitHub パイプラインの認証に使用されるクライアント シークレット。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
tenant-id app-id と client-secret を使用した認証時のテナント ID。
solution-name (必須) アップグレードするソリューションの名前。
非同期 ソリューションを非同期にアップグレードします。
max-async-wait-time 分単位での最大非同期待機時間。 既定値は 60 分です。

パッケージのタスク

これらのタスクは、パッケージに対してアクションを実行します。

deploy-package

パッケージ DLL またはパッケージを含む ZIP ファイルをデプロイします。

注記

このアクションは、Windowsでのみサポートされます。

パラメーター 説明
environment-url (必須) ソリューションの複製元となる環境の URL (たとえば、https://YourOrg.crm.dynamics.com)。
user-name (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用しているアカウントのユーザー名。
password-secret (必須) ユーザー名/パスワード認証を使用している場合は、接続に使用しているアカウントのパスワード。
app-id 認証に使用するアプリケーション ID。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
client-secret GitHub パイプラインの認証に使用されるクライアント シークレット。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
tenant-id app-id と client-secret を使用した認証時のテナント ID。
パッケージ (必須)パッケージを含むパッケージ DLL または ZIP ファイルへのパス。

ポータルのタスク

これらのタスクは、Power Pages に対して次のアクションを実行します。

upload-paportal

データを Power Pages にアップロードします。

パラメーター 説明
environment-url (必須) ソリューションをインポートする環境の URL (たとえば、https://YourOrg.crm.dynamics.com)。
app-id 認証に使用するアプリケーション ID。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
client-secret GitHub パイプラインの認証に使用されるクライアント シークレット。 このパラメータは、サービス プリンシパルの認証情報を使用して認証する場合に 必須 です。
tenant-id app-id と client-secret を使用した認証時のテナント ID。
アップロード パス Web サイトのコンテンツが保存されているパス (エイリアス: -p)。
deployment-profile deployment-profiles/[profile-name].deployment.yaml ファイルのプロファイル変数 を介して定義された環境詳細でポータル データをアップロードします。
モデル バージョン アップロードするサイト データが標準 (1) または 拡張データ モデル (2) を使用しているかどうかを示します。 既定値は、1 です。

Power Pages 向けの Microsoft Power Platform CLI サポートの詳細を見る。

タスクのカタログ (プレビュー)

これらのタスクは、Power Platform のカタログに対してアクションを実行します。

注記

現在、Power Platform のカタログ タスクはプレビュー段階です。

インストール

ターゲット環境に Catalog の項目をインストールします。

パラメーター 説明
catalog-item-id (必須)ターゲット環境にインストールするカタログ項目。
target-url (必須) カタログ項目をインストールする対象環境のURL (たとえば、https://YourOrg.crm.dynamics.com)。
設定 (必須) 実行するインストール フレームワークのランタイム パッケージの設定。 文字列の式は key=value|key=value になります。
target-version インストールする対象のバージョン。 バージョンを指定しない場合、公開バージョンが選択されます。
poll-status リクエストのステータスを確認するためにポーリングします。

submit

現在の Dataverse 環境 (組織) から公開されたすべてのカタログ項目をリストアップします。

パラメーター 説明
パス (必須) カタログ提出ドキュメントへのパス。
package-zip パッケージ ZIP ファイルのパス。
solution-zip ソリューション ZIP ファイルのパス。
poll-status リクエストの状態を確認するため、ポーリングを行います。

状態

カタログのインストールまたは送信リクエストの状態を取得します。

パラメーター 説明
tracking-id (必須) 要求追跡 ID
型 (必須) リクエストの種類。 有効値は Install または Submit です。

GitHub ワークフロー作成

GitHub Actionsを使用したGitHubワークフローの作成の詳細については、Microsoft Power Platform 向け GitHub Actions ラボを完了してください。

詳細については、「GitHub Actionsについて」を参照してください。

関連項目

Microsoft Power Platform 向け GitHub Actions