最初のパイプライン

「uip solution」ツールを使用して、UiPath ソリューションをエンドツーエンドでパッケージ化してパブリッシュし、Orchestrator にデプロイします。

このページでは、ディスク上の UiPath ソリューションをエンドツーエンドで Orchestrator に配布する方法、つまり、ローカルに パッケージ化 してテナントのソリューション フィードに パブリッシュ し、 フォルダーにデプロイする方法について説明します 。これは、開発者のラップトップとCIパイプラインから同じように機能する solution ツールを使用します。

必要なもの

• UiPath CLI がインストールされていて、ログインしているセッションがある。「 UiPath CLI と認証をインストールする 」をご覧ください。
• ディスク上の UiPath ソリューション 。uip solution pack は、次の 2 つのシェイプのいずれかを受け入れます (CLI 独自のsolution pack --helpに一致します)。
  • .uipxソリューション記述子 (Studio が書き込み、uip solution init作成するもの) を含むソリューション ディレクトリ
  • スタンドアロンの .uis ファイル (事前にバンドルされたソリューションの成果物)
• ソリューションをデプロイする Orchestrator フォルダー パスです (例: Shared/MySolutionFolder)。

フロー

3 つのコマンドがそれぞれ個別のステップであるため、CI パイプラインで個別に実行できます。

1. uip solution pack — ソリューション ディレクトリからバージョン管理された .zip パッケージを生成します。
2. uip solution publish — テナントのソリューション フィードに .zip をアップロードします。
3. uip solution deploy run — フォルダーを作成し、パブリッシュしたパッケージを Orchestrator にデプロイします。

ステップ1.ソリューションを梱包する

uip solution pack ./my-solution ./dist \
  --name my-solution \
  --version 1.0.0

引数：

• 最初の位置引数は、ソリューション ディレクトリ (または .uis ファイル) です。
• 2 つ目は出力ディレクトリです。uip 存在しない場合は作成します。

フラグ：

• パッケージ名 (既定: ソリューション ディレクトリ名) を上書き--name。
• --version パッケージのバージョンを設定します (既定値: 1.0.0)。読みやすくし、Orchestrator でバージョンを正しく並べ替えられるようにするには、セマンティック バージョニングを使用します。

成功すると、 ./dist/my-solution_1.0.0.zip が書かれます。JSON 応答は、 Data.Package ( name@version形式) と Data.Packages (書き込まれた .zip パス) を返します。.zip パス自体は {outputDir}/{name}_{version}.zipの規則に従っているため、パイプラインは JSON を解析することなくこのパスを構築できます。

NAME=my-solution
VERSION=1.0.0
uip solution pack ./my-solution ./dist --name "$NAME" --version "$VERSION"
PACKAGE="./dist/${NAME}_${VERSION}.zip"

ステップ2.テナントにパブリッシュします。

uip solution publish ./dist/my-solution_1.0.0.zip

パッケージがテナントのソリューション フィードにアップロードされます。Orchestrator は、テナント上のこの特定のバージョンの PackageVersionKey を割り当てます。publish は (name, version) ごとのべき等です。同じバージョンで再実行すると、複製されるのではなく、既存のバージョンが返されます。

ヒント:

マルチテナント組織の特定のテナントに対して実行する場合は、publish で --feed <name-or-key> または --personal-workspace を使用して、テナント内の特定のフィードをターゲットにします。pack は、フィードから NuGet の依存関係を解決する場合にのみテナントと通信します。確信が持てない場合は、CLI が現在バインドされているテナントuip login statusが表示されます。に切り替えますuip login tenant set <tenant>

ステップ3.Orchestrator にデプロイする

uip solution deploy run \
  --name MyFirstDeployment \
  --package-name my-solution \
  --package-version 1.0.0 \
  --folder-name MySolutionFolder \
  --parent-folder-path Shared

フラグ (特に明記されていない限り必須):

• --name — デプロイ名 (パッケージ名ではない) です。意味のあるものを使用してください。これにより、今後の deploy status / deploy activate 呼び出しのデプロイが識別されます。
• --package-name、 --package-version — 手順 2 でパブリッシュした内容と一致します。
• --folder-name — このデプロイ用に作成する Orchestrator のフォルダーです。
• --parent-folder-path — 親フォルダーのパスです。Shared テナント ルートです。
• --parent-folder-key — 親フォルダーの GUIDID でバインドする場合は、 --parent-folder-path の代わりにこれを使用します。

deploy run は、デプロイが終了ステート (既定のポーリング タイムアウトは 360 秒で、 --timeoutで調整可能) に達するまで Orchestrator をポーリングします。応答には、新しいフォルダーのパスとデプロイ キーが含まれます。

注:

--name と --folder-name は 2つの異なるものです。--name デプロイ レコードに名前を付けます。 --folder-name 、デプロイによって作成される新しい Orchestrator フォルダーの名前が付けられます。両方に同じ値を選択するのは問題ありませんし、一般的です。

CIにまとめる

#!/usr/bin/env bash
set -euo pipefail

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

uip solution pack ./my-solution ./dist --version "$BUILD_VERSION"
uip solution publish "./dist/my-solution_$BUILD_VERSION.zip"
uip solution deploy run \
  --name "my-solution-$GIT_SHA" \
  --package-name my-solution \
  --package-version "$BUILD_VERSION" \
  --folder-name MySolutionFolder \
  --parent-folder-path Shared

スクリプトは最初の 0 以外のステータスで終了するため、いずれかのステップでエラーが発生するとビルドが中止されます。uip は、成功した場合は 0 を返し、失敗した場合は 1 を返します。ドメイン固有のセマンティクスを持つコマンド (例えば、タイムアウトに2を再利用する uip tm waitなど) は、他のコードを返す可能性があります — 終了コードを参照してください。

デプロイ後

ソリューションがデプロイされると、Orchestrator にはフォルダー (Shared/MySolutionFolder)、ソリューション内のデプロイ可能なプロジェクトごとのプロセス、および関連するすべてのリソース (アセット、キュー、トリガー) があります。これで次の操作が可能になります。

# confirm the folder exists
uip or folders list --all --path "Shared/MySolutionFolder"

# find the processes that were created
uip or processes list --folder-path "Shared/MySolutionFolder"

# start a job
uip or jobs start <process-key>

# inspect the deployment
uip solution deploy status <pipeline-deployment-id>

Studio のプロジェクトが 1 つしかない場合はどうでしょうか。

単一の Studio プロジェクト (ソリューションではなく project.json を含むディレクトリ) の場合、クラシック パイプラインはpack a .nupkg → upload to a feed → create a processです。このフローでは、 rpa ツールと or ツールのコマンドを使用します。

uip rpa pack ./MyStudioProject ./dist
uip or packages upload ./dist/MyStudioProject.1.0.0.nupkg
uip or processes create \
  --name MyProcess \
  --package-key MyStudioProject \
  --package-version 1.0.0 \
  --folder-path Shared

完全なフラグのリストについては、 uip rpa および Orchestrator のパッケージ と プロセスの リファレンスをご覧ください。

次のステップ

• 方法: CI から Orchestrator にデプロイ する — CI プラットフォームごとのバリアント。
• CI/CD レシピ: Azure DevOps、 GitHub Actions、 Jenkins、 GitLab。
• uip solution reference — すべての solution サブコマンド。
• ソリューションをパッケージ化して公開する (使い方) — バージョン管理戦略や複数環境の昇格など、より詳細にカバーできます。