CI/CD 秘钥：GitHub Actions

此页面为您提供完整的.github/workflows/deploy.yml ，用于安装 CLI，使用外部应用程序进行身份验证，打包并发布 UiPath 解决方案，将其部署到 Orchestrator，以及针对部署运行 Test Manager 套件。将其拖放到您的存储库中，添加两个密码，然后即可运行。

有关基本原则（身份验证、缓存、工具预安装、版本固定），请参阅操作方法：从 CI 部署到 Orchestrator 。本页面重点介绍 GitHub 操作语法。

先决条件

在复制以下 YAML 之前：

1. 在 UiPath 中使用管道所需的OR.*作用域创建外部应用程序。请参阅身份验证 — 流程2 。
2. 将密码存储在存储库（或组织/环境）设置中：
   • 设置 → “密码和变量” → 操作 →新建存储库密码。
   • 将UIPATH_CLIENT_ID和UIPATH_CLIENT_SECRET添加为密码。
   • 将UIPATH_TENANT添加为变量（非密码 — 不敏感）。
3. 如果您需要测试作业，请配置 Test Manager 项目和测试集。将TEST_SET_KEY （例如存储库变量中添加PROJECT:42 ）和PROJECT_KEY 。请参阅操作方法：从 CLI 运行测试。

.github/workflows/deploy.yml

name: Deploy UiPath Solution

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]
  workflow_dispatch:

env:
  CLI_VERSION:      '1.0.0'
  NODE_VERSION:     '20'
  SOLUTION_NAME:    'my-solution'
  SOLUTION_DIR:     './my-solution'
  OUTPUT_DIR:       './dist'

jobs:

  build:
    name: Pack Solution
    runs-on: ubuntu-latest
    outputs:
      solution_version: ${{ steps.version.outputs.version }}
    steps:

      - uses: actions/checkout@v4

      - name: Compute version
        id: version
        run: echo "version=1.2.0-ci.${{ github.run_number }}" >> "$GITHUB_OUTPUT"

      - uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}

      - name: Cache npm global (@uipath/cli)
        uses: actions/cache@v4
        with:
          path: ~/.npm-global/lib/node_modules
          key:  uip-${{ env.CLI_VERSION }}-${{ runner.os }}

      - name: Install UiPath CLI
        shell: bash
        run: |
          set -euo pipefail
          mkdir -p "$HOME/.npm-global"
          npm config set prefix "$HOME/.npm-global"
          echo "$HOME/.npm-global/bin" >> "$GITHUB_PATH"
          export PATH="$HOME/.npm-global/bin:$PATH"

          if ! command -v uip >/dev/null; then
            npm install -g "@uipath/cli@${CLI_VERSION}"
          fi
          uip --version

      - name: Pack Solution
        id: pack
        shell: bash
        run: |
          set -euo pipefail
          mkdir -p "$OUTPUT_DIR"
          uip solution pack "$SOLUTION_DIR" "$OUTPUT_DIR" \
            --name "$SOLUTION_NAME" \
            --version "${{ steps.version.outputs.version }}"
          ARTIFACT=$(find "$OUTPUT_DIR" -maxdepth 1 -name "*.zip" | head -1)
          echo "artifact=$ARTIFACT" >> "$GITHUB_OUTPUT"

      - uses: actions/upload-artifact@v4
        with:
          name: solution-zip
          path: ${{ steps.pack.outputs.artifact }}

  deploy:
    name: Publish and deploy
    needs: build
    runs-on: ubuntu-latest
    environment: uipath-prod   # attach approval gates here if needed
    steps:

      - uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}

      - name: Cache npm global (@uipath/cli)
        uses: actions/cache@v4
        with:
          path: ~/.npm-global/lib/node_modules
          key:  uip-${{ env.CLI_VERSION }}-${{ runner.os }}

      - name: Install UiPath CLI
        shell: bash
        run: |
          set -euo pipefail
          mkdir -p "$HOME/.npm-global"
          npm config set prefix "$HOME/.npm-global"
          echo "$HOME/.npm-global/bin" >> "$GITHUB_PATH"
          export PATH="$HOME/.npm-global/bin:$PATH"

          if ! command -v uip >/dev/null; then
            npm install -g "@uipath/cli@${CLI_VERSION}"
          fi

      - uses: actions/download-artifact@v4
        with:
          name: solution-zip
          path: ${{ env.OUTPUT_DIR }}

      - name: Authenticate
        shell: bash
        env:
          UIPATH_CLIENT_ID:     ${{ secrets.UIPATH_CLIENT_ID }}
          UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
          UIPATH_TENANT:        ${{ vars.UIPATH_TENANT }}
        run: |
          set -euo pipefail
          uip login \
            --client-id env.UIPATH_CLIENT_ID \
            --client-secret env.UIPATH_CLIENT_SECRET \
            --tenant "$UIPATH_TENANT"

      - name: Publish to tenant feed
        shell: bash
        run: |
          set -euo pipefail
          ARTIFACT=$(find "$OUTPUT_DIR" -maxdepth 1 -name "*.zip" | head -1)
          uip solution publish "$ARTIFACT"

      - name: Deploy to Orchestrator
        shell: bash
        run: |
          set -euo pipefail
          uip solution deploy run \
            --name "${SOLUTION_NAME}-${{ github.run_number }}" \
            --package-name "$SOLUTION_NAME" \
            --package-version "${{ needs.build.outputs.solution_version }}" \
            --folder-name MySolution \
            --folder-path Shared

  test:
    name: Run Test Manager suite
    needs: deploy
    if: ${{ vars.TEST_SET_KEY != '' }}
    runs-on: ubuntu-latest
    steps:

      - uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}

      - name: Cache npm global (@uipath/cli)
        uses: actions/cache@v4
        with:
          path: ~/.npm-global/lib/node_modules
          key:  uip-${{ env.CLI_VERSION }}-${{ runner.os }}

      - name: Install CLI and authenticate
        shell: bash
        env:
          UIPATH_CLIENT_ID:     ${{ secrets.UIPATH_CLIENT_ID }}
          UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
          UIPATH_TENANT:        ${{ vars.UIPATH_TENANT }}
        run: |
          set -euo pipefail
          mkdir -p "$HOME/.npm-global"
          npm config set prefix "$HOME/.npm-global"
          echo "$HOME/.npm-global/bin" >> "$GITHUB_PATH"
          export PATH="$HOME/.npm-global/bin:$PATH"

          if ! command -v uip >/dev/null; then
            npm install -g "@uipath/cli@${CLI_VERSION}"
          fi

          uip login \
            --client-id env.UIPATH_CLIENT_ID \
            --client-secret env.UIPATH_CLIENT_SECRET \
            --tenant "$UIPATH_TENANT"

      - name: Launch, wait, verify
        shell: bash
        env:
          TEST_SET_KEY: ${{ vars.TEST_SET_KEY }}
          PROJECT_KEY:  ${{ vars.PROJECT_KEY }}
        run: |
          set -euo pipefail

          EXECUTION_ID=$(uip tm testsets run \
            --test-set-key "$TEST_SET_KEY" \
            --output-filter "Data.ExecutionId" \
            --output plain)

          echo "started execution $EXECUTION_ID"

          if ! uip tm wait \
            --execution-id "$EXECUTION_ID" \
            --project-key "$PROJECT_KEY" \
            --timeout 1800; then
            code=$?
            case "$code" in
              2) echo "::error::test run did not finish within 30 minutes"; exit 2 ;;
              *) echo "::error::wait failed (exit $code)"; exit "$code" ;;
            esac
          fi

          uip tm report get \
            --execution-id "$EXECUTION_ID" \
            --project-key "$PROJECT_KEY"

          FAILED=$(uip tm report get \
            --execution-id "$EXECUTION_ID" \
            --project-key "$PROJECT_KEY" \
            --output-filter "Data.Failed" \
            --output plain)

          if [ "$FAILED" -gt 0 ]; then
            echo "::error::$FAILED test case(s) failed"
            exit 1
          fi

演练

构建作业

• actions/setup-node@v4将节点固定到由NODE_VERSION指定的主要版本。CLI 要求 Node 18 及更高版本。
• actions/cache@v4缓存 npm 全局node_modules目录，键入固定的 CLI 版本和运行程序操作系统。当缓存点击时，安装步骤的if ! command -v uip防护机制就会变为空操作。
• “安装”步骤会配置用户本地 npm 前缀（GitHub 托管的运行器上不需要sudo ），将其添加到GITHUB_PATH中，以便后续步骤中看到uip命令，并安装 CLI。首次调用工具命令（ uip solution … 、 uip tm … ）时，系统会自动安装该工具 — 无需明确的uip tools install 。请参阅安装 UiPath CLI — CI/CD 。
• 打包步骤使用根据uip solution pack构建的显式--version调用github.run_number （单调，存储库中每次运行唯一）。此步骤使用find捕获生成的.zip路径，而不是对文件名进行硬编码 — 即使 CLI 命名约定发生更改，也能保持方法稳定。
• actions/upload-artifact@v4上传捕获的.zip ，以便deploy作业可以在下次运行中下载它。
• outputs.solution_version将计算的版本传播到deploy作业，这是在同一工作流中的作业之间共享值的最简单方法。

部署作业

• 重新安装 CLI — needs: build强制执行作业订单，但每个作业都在全新的运行器上运行。缓存应在第二次安装时点击。
• actions/download-artifact@v4将solution-zip拉取到$OUTPUT_DIR中。
• 身份验证步骤通过步骤的env:块传递密码，然后uip login通过env.前缀读取密码。env.VAR_NAME前缀是受支持的向命令行隐藏机密信息的方式 — 请参阅身份验证 — env.VAR_NAME 前缀。请勿写入--client-secret "${{ secrets.UIPATH_CLIENT_SECRET }}" — 会将值嵌入到呈现的命令和步骤日志中。
• 发布 + 部署步骤使用uip solution publish和uip solution deploy run 。--name使用github.run_number ，因此每个部署都可识别。
• environment: uipath-prod将作业与部署环境绑定。您可以在环境中配置所需的审核人、等待计时器和部署分支。将这些内容配置在用户界面中，并保留 YAML 声明格式。

测试作业

仅在设置了TEST_SET_KEY存储库变量时运行，否则if:防护机制会跳过它。shell 块是“操作方法：从 CLI 运行测试” 中的规范“启动”→“等待”→“验证” 模式：

1. uip tm testsets run启动并返回ExecutionId 。
2. uip tm wait会阻止，直到最终状态。退出2意味着wait超时（非身份验证失败）；退出代码通过::error::报告，因此会显示在“操作”用户界面中。
3. uip tm report get为Data.Failed ，并且该步骤将在1失败时退出。

常见变体

跨环境提升

使用不同的密码添加依赖于第一个 deploy 作业的第二个作业：

  deploy-stage:
    needs: build
    environment: uipath-stage
    # …same steps as `deploy`, using ${{ secrets.UIPATH_STAGE_CLIENT_ID }} etc.

  deploy-prod:
    needs: deploy-stage
    environment: uipath-prod    # add "Required reviewers" in the environment settings
    # …same steps as `deploy`, using ${{ secrets.UIPATH_PROD_CLIENT_ID }} etc.

审批网关位于环境设置中 — needs:链强制执行顺序。请参阅操作方法：打包并发布解决方案 — 跨租户提升一个包。

回滚

添加workflow_dispatch输入和重新部署特定版本的受保护作业：

on:
  workflow_dispatch:
    inputs:
      rollback_version:
        description: 'Version to roll back to (e.g. 1.1.9)'
        required: false
        type: string

jobs:
  rollback:
    if: ${{ github.event.inputs.rollback_version != '' }}
    runs-on: ubuntu-latest
    # …install + auth…
    steps:
      - name: Re-deploy previous version
        run: |
          uip solution deploy run \
            --name "${SOLUTION_NAME}-rollback" \
            --package-name "$SOLUTION_NAME" \
            --package-version "${{ github.event.inputs.rollback_version }}" \
            --folder-name MySolution \
            --folder-path Shared

使用“操作触发”→“部署 UiPath 解决方案”→“运行工作流并输入回滚版本”。有关破坏性回滚（卸载 + solution packages delete ），请参阅操作方法：打包并发布解决方案 — 回滚。

跳过测试

设置（或未设置） TEST_SET_KEY存储库变量。if: ${{ vars.TEST_SET_KEY != '' }}防护机制会跳过整个作业。

常见错误

• ${{ secrets.X }}插值。它将替代逐步渲染层。如果您将密码直接放入run:命令行中，该值将成为呈现脚本和步骤日志的一部分，除非 GitHub 对其进行掩码。始终通过env:路由机密信息，并在uip中使用env.VAR_NAME读取机密信息。
• $GITHUB_PATH与$PATH 。在一个步骤中导出PATH=… ，不会进入下一个步骤。使用echo "…" >> "$GITHUB_PATH"在同一运行器上的步骤中添加路径。
• strict shell options 。以run:开头的每个多行set -euo pipefail — 如果没有它，失败的uip solution pack后可以“成功”发布过时的工件。请参阅脚本编写模式—严格 shell 选项。
• 缓存误报。如果生成CLI_VERSION ，但缓存键中不包含该键，则您将继续使用旧版 CLI。正因为如此，此 YAML 中的密钥包含${{ env.CLI_VERSION }} 。
• 缓存路径与 npm 前缀耦合。缓存块使用~/.npm-global/lib/node_modules ，而后者仅在安装步骤运行时才有效。 npm config set prefix "$HOME/.npm-global"如果您更改前缀（例如在约定为%APPDATA%\npm\node_modules自托管 Windows 运行器上），则缓存path:和npm config set prefix行必须一起移动。在非 ubuntu 最新版的运行器上，首先使用- run: npm root -g转储真实路径，然后镜像其报告的任何内容。

另请参阅

• 操作方法：从 CI 部署到 Orchestrator — 与平台无关的指南。
• 操作方法：打包并发布解决方案— 版本控制和回滚。
• 操作方法：从 CLI 运行测试— 启动 → 等待 → 验证模式。
• CI/CD 秘方：Azure Pipelines 、 Jenkins 、 GitLab CI — 其他平台中的相同管道。