用于 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 生成工具。

配置凭据后,可以从 Action 脚本中调用服务主体。

在GitHub操作脚本中将以下参数定义为环境变量:

  • 应用程序 ID,例如: WF_APPLICATION_ID:<your application id>
  • 租户 ID,例如: WF_TENANT_ID:<your tenant id>

将客户端密钥添加为 GitHub Secret。 使用如下所示的参数从工作流中引用它: client secret: ${{secrets.CLIENT_SECRET_GITHUB_ACTIONS}}

辅助任务

以下辅助任务可用。

actions-install

当 GitHub Actions 工作流在运行器上下文中强制安装 Power Platform CLI 时,如果发生超时错误,请使用版本 1 (@v1) 并添加一个额外操作 (actions-install),如下例所示。

重要

  • 使用版本 1 (@v1) 可能会导致现有 GitHub 操作的更新,从而导致当前工作流被更新。
  • 在 Power Platform 的任何其他GitHub Actions之前,将“安装 Power Platform 工具”任务添加为工作流中的第一个任务。
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'

可以在 Power Platform Actions 中找到更多GitHub Actions示例。

whoAmI

通过连接到服务并发送 WhoAmI [SDK/Web API] 请求来验证服务连接。 此任务适合在 GitHub 工作流早期加入,以便在开始处理前验证连接是否正常。

参数 描述
environment-url 您连接到的环境的 URL。
user-name 您用于连接的帐户的用户名。
password-secret user-name 的密码。 在设置下的密钥中定义 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 (必需)如果您使用用户名/密码身份验证,为用于连接的帐户的密码。
解决方案文件 (必需)要导入的解决方案文件的路径和名称。
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 (必需)如果您使用的是用户名/密码身份验证,为 user-name 的密码。 在设置下的密钥中定义 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.zip 文件的路径和文件名。
solution-folder (必需)要解压缩解决方案的路径和目标文件夹。
solution-type (必需)您要解压的解决方案类型。 选项包括非托管(建议)、托管和两者。

pack-solution

将源代码控制中的解决方案打包为 solution.zip 文件,以便您将其导入到另一个环境中。

参数 描述
solution-file (必填)要将解决方案打包到的 solution.zip 文件的路径和文件名(例如,out/CI/ALMLab.zip)。
解决方案文件夹 (必需)要打包的解决方案的路径和源文件夹。
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 仓库\target-solution-folder)。
Working-directory 克隆解决方案所需的工作中项目的临时文件夹。
默认值:root of the repository

check-solution

检查解决方案文件以检测不一致。

参数 描述
环境-URL (必需)要从其克隆解决方案的环境的 URL(例如,https://YourOrg.crm.dynamics.com)。
user-name (必需)如果您使用用户名/密码身份验证,为用于连接的帐户的用户名。
password-secret (必需)如果您使用用户名/密码身份验证,请输入您用于连接的帐户密码。
app-id 用于进行身份验证的应用程序 ID。 在使用服务主体凭据进行身份验证时,此参数是必需的。
client-secret 用于对 GitHub 管道进行身份验证的客户端密码。 在使用服务主体凭据进行身份验证时,此参数必需。
tenant-id 使用 app-id 和 client-secret 进行身份验证时的租户 ID。
路径 (必需)要检查的解决方案文件的路径和文件名。
地区 要使用的 Microsoft Power Platform 检查器服务的地理位置。 默认值为“united states”。
规则级覆盖 其中包含规则的 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”。

升级解决方案

升级该解决方案。

参数 描述
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。
upload-path 存储网站内容的路径(别名:-p)。
deployment-profile 上载门户数据,其中包含通过 deployment-profiles/[profile-name].deployment.yaml 文件中的profile 变量定义的环境详细信息。
模型版本 指示要上传的网站数据是否使用标准(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 要安装的目标版本。 如果未指定版本,将选择已发布的版本。
轮询状态 轮询以查看请求状态。

提交

列出当前 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