uip solution pack

「uip solution pack」の構文とオプション - ソリューション ディレクトリまたは '.uis' バンドル ファイルからデプロイ可能な '.zip' を生成します。

uip solution pack は、ソリューション ディレクトリ (.uipx マニフェストを含む) または .uis バンドル ファイルから配置可能な .zip パッケージを生成します。生成されるアーカイブは、uip solution publish がテナント フィードにアップロードしuip solution deploy run、フィードをデプロイできます。

Pack is an offline operation — it does not contact Orchestrator except to resolve NuGet dependencies from tenant feeds (or an Orchestrator folder's library feed via --feed-folder), and does not contact AutomationOps except when a governance flag or --ignored-rules is passed while you are signed in — so it is safe to run inside build steps that do not yet have full credentials, as long as dependency resolution is covered.

概要

uip solution pack <solutionPath> [outputPath] \
  [--name <name>] [--version <version>] \
  [--project <id-or-path> [--package-id <id>]] \
  [--dry-run] \
  [--skip-analyze] [--ignored-rules <rules>] [--governance-file-path <path>] [--governance-product <product>] \
  [--nuget-sources-config-path <path>] [--exclude-configured-sources] [--feed-folder <name>] \
  [--signing-certificate-path <path>] [--signing-certificate-password <password>] [--signing-timestamp-server <url>] \
  [--author <text>] [--description <text>] [--release-notes <text>] [--project-url <url>] \
  [--repository-url <url>] [--repository-commit <sha>] [--repository-branch <branch>] [--repository-type <type>] \
  [--login-validity <minutes>]

このコマンドは 、グローバルオプション を尊重し、 標準の終了コードを返します。

引数

• <solutionPath> (必須) — ソリューション ディレクトリ ( .uipx マニフェストを含む) または .uis ファイルへのパスです。
• [outputPath] (任意) — .zip パッケージが書き込まれる出力ディレクトリです。--dry-runが設定されていない限り必須です。--dry-run指定せずに省略すると、どちらかを追加するためのポインターが表示されて失敗します。

オプション

Core

長押し	値 (Value)	既定 (Default)	説明
-n, --name <name>	text	ソリューションのフォルダー名 (または .uis ファイルのベース名)	パッケージ名。パッケージ化された .zip の名前は <name>_<version>.zipです。
-v, --version <version>	text	1.0.0	パッケージ バージョン。出力ファイル名に表示され、 で deploy run--package-version に渡される値です。
--project <id-or-path>	project Id or path	—	Pack only this project of the solution into its own .nupkg, instead of the solution .zip. Takes the project's Id from the .uipx, or its path relative to the solution folder; separators and case are ignored. The project packs as a stand-alone project, so no solution resources go into it. Not supported for a .uis file, and cannot be combined with --name. Refer to Pack one project.
--package-id <id>	text	the id a whole-solution pack gives the project	Package id for the project packed with --project. Without it, the project keeps the id a whole-solution pack gives it: the one the solution saved, else <solution>.<type>.<project folder>. Requires --project.
--dry-run	フラグ	無効	使い捨ての一時コピーに対してフル パック パイプライン (リソース同期、実行時依存関係の排出、パッケージャー オプションの検証) を実行し、出力を破棄します。パック時の失敗 (依存関係の欠落、リソース バインディングの破損、アンパック可能なプロジェクトの種類) を、 .zip を生成したりソリューションに書き戻したりすることなくキャッチします。生成されたパッケージの内容物は検査 されないため 、ソリューション フィードが結果を受け入れることを保証することはできません。[outputPath]オプションにします。
--login-validity <minutes>	分	10	Minimum minutes before token expiration to trigger a refresh. Only relevant when dependency resolution needs a tenant feed, or when the tenant's governance policy is checked.

依存関係の解決

長押し	値 (Value)	既定 (Default)	説明
--nuget-sources-config-path <path>	パス	—	プロジェクトの依存関係を解決するための NuGet ソース構成ファイルへのパスです。
--exclude-configured-sources	フラグ	無効	依存関係は、テナント フィードと --nuget-sources-config-pathからのみ解決します。組み込みの UiPath フィードと nuget.org フィードを削除します。これらのフィードに依存していない依存関係は復元できません。
--feed-folder <name>	名前またはパス	—	すべてのテナント フィードではなく、この Orchestrator フォルダーのライブラリ フィードからの依存関係を解決します。フォルダー名または完全修飾パスを受け入れます。

ガバナンスの分析

--skip-analyze, --ignored-rules, --governance-file-path, and --governance-product control the workflow analyzer that runs against every RPA project in the solution. The flags can be combined.

長押し	値 (Value)	既定 (Default)	説明
--skip-analyze	フラグ	無効	すべての RPA プロジェクトでワークフロー アナライザーをスキップします。コンパイルと検証は引き続き実行され、アナライザーのルールのみがスキップされます。
--ignored-rules <rules>	comma-separated rule IDs	—	Analyzer rule IDs whose findings are ignored for every RPA project, for example ST-USG-034,ST-MRD-002. Repeat the flag to add more. The rules still run, but their findings are not reported and do not fail the pack. Applies on top of --governance-file-path or the shipped rules. When the signed-in tenant publishes an AutomationOps policy, the list is not applied and a warning says so.
--governance-file-path <path>	パス	—	Analyze every RPA project against this local governance policy file instead of the analyzer rules shipped with the WorkflowCompiler. Accepts a policy exported from AutomationOps or a Studio rules-configuration file. When you are signed in, the tenant is asked first (about StudioWeb, unless --governance-product names another product). When the tenant publishes a policy of its own, that policy is used, this file is ignored with a warning, and the pack continues. When the tenant publishes no policy, when it cannot be asked, or when its policy service does not answer, this file is used. The file is read before the tenant is asked, so an unreadable or non-JSON file fails the pack in every case.
--governance-product <product>	text	—	サインインしているテナントに対して、すべての RPA プロジェクトを Automation Ops でパブリッシュされたガバナンス ポリシーに照らして分析します。値は、ポリシーをダウンロードした 製品 です (例: StudioWeb、 Development、 Business)。

いずれかのガバナンス フラグの空の値 (--governance-file-path "") は間違いとして拒否され、警告なしに「フラグなし」として扱われることはありません。

パッケージの署名

パッケージ済みのプロジェクトの.nupkgに署名するには、PATHの dotnet CLI が必要です。

長押し	値 (Value)	既定 (Default)	説明
--signing-certificate-path <path>	パス	—	.pfxコード署名証明書へのパスです。設定すると、ソリューション内のすべてのパックされたプロジェクト .nupkg 署名されてから、ソリューション .zipにバンドルされます。
--signing-certificate-password <password>	text または env.VAR	—	証明書のパスワード。シェル履歴ではなく環境変数から読み取るように env.ENV_NAME 渡します。
--signing-timestamp-server <url>	URL	—	署名のタイムスタンプ サーバー URL です。

パッケージのメタデータ (ソースの追跡性)

These flags stamp traceability metadata into a package.metadata.json file at the archive root and into each project's .nuspec. None are required. When --author or --description is omitted, each member project keeps the value its own project file declares, and falls back to UiPath / Created by UiPath when it declares none.

長押し	値 (Value)	既定 (Default)	説明
--author <text>	text	each project's own author, else UiPath	Package author. When set, applies to every member project.
--description <text>	text	each project's own description, else Created by UiPath	Package description. When set, applies to every member project.
--release-notes <text>	text	—	パッケージのリリース ノート
--project-url <url>	URL	—	Automation Hub のアイデアの URL
--repository-url <url>	URL	—	ソース リポジトリの URL です。
--repository-commit <sha>	text	—	ソース リポジトリのコミット ハッシュ。
--repository-branch <branch>	text	—	ソース リポジトリ ブランチ。
--repository-type <type>	text	git ( --repository-url が設定されている場合)	ソース リポジトリの種類。[ --repository-url ] も設定されている場合にのみ記録されます。

例

最小限

uip solution pack ./my-solution ./dist

ソリューションを ./my-solution で ./dist/my-solution_1.0.0.zip (既定のバージョン) にパックします。

共通 — CI ビルドのピン名とバージョン

uip solution pack ./my-solution ./dist --name invoices --version 1.2.0

./dist/invoices_1.2.0.zip書き込みます。

パッケージ化せずに検証

uip solution pack ./my-solution --dry-run

一時ディレクトリに対してフル パック パイプラインを実行し、出力を破棄します。リソース バインディング、変数参照、ランタイム依存関係のエラーを outputPathなしでキャッチできるため、CI のデプロイ前のゲートとして便利です。

スタンプのソース トレーサビリティ メタデータ

uip solution pack ./my-solution ./dist --version 1.2.0 \
  --repository-url https://github.com/acme/repo \
  --repository-commit abc123 \
  --repository-branch main \
  --release-notes "v1.2.0"

パッケージ化されたプロジェクトに署名する

uip solution pack ./my-solution ./dist --version 1.2.0 \
  --signing-certificate-path ./cert.pfx \
  --signing-certificate-password env.UIPATH_SIGNING_CERTIFICATE_PASSWORD \
  --signing-timestamp-server http://timestamp.digicert.com

ワークフロー アナライザーをスキップ

uip solution pack ./my-solution ./dist --version 1.2.0 --skip-analyze

コンパイルと検証は引き続き実行され、アナライザーのルールのみがスキップされます。

テナントのガバナンス ポリシーに対して分析する

uip solution pack ./my-solution ./dist --version 1.2.0 --governance-product Development

Ignore specific analyzer rules

uip solution pack ./my-solution ./dist --version 1.2.0 --ignored-rules ST-USG-034,ST-MRD-002

The rules still run, but their findings do not fail the pack. The list is not applied when the tenant publishes an AutomationOps policy.

Pack one project

uip solution pack ./my-solution ./dist --project MyProcess --package-id Acme.MyProcess --version 1.2.0

--project produces the project's .nupkg instead of the solution .zip, for example to publish one project to an Orchestrator feed on its own. --name names the solution .zip, so it cannot be used with --project; --package-id names the project package.

スクリプティング — パブリッシュ ステップの出力パスをキャプチャします。

PKG=$(uip solution pack ./my-solution ./dist --version 1.2.0 --output-filter "Packages" --output plain)
uip solution publish "$PKG"

データシェイプ(--output json)

リアルパック:

{
  "Code": "SolutionPack",
  "Data": {
    "Package": "my-solution@1.2.0",
    "Packages": "./dist/my-solution_1.2.0.zip"
  }
}

• Package — パックされたソリューションの <name>@<version> 識別子です。
• Packages — <outputPath>に書き込まれる.zipパスのコンマ区切りのリストです。通常は 1 つのパスです。

ドライ ラン (--dry-run):

{
  "Code": "SolutionPack",
  "Data": {
    "Package": "my-solution@1.0.0",
    "DryRun": true,
    "Status": "Valid"
  }
}

When the pack fails and the packager reports per-project results, the failure envelope carries Data.Projects, one entry per member project:

フィールド	説明
Path	The project directory, relative to the solution directory, with forward slashes.
Type	The project type.
Result	Success または Failure。
Message	The project's result message, when it has one.
Findings	The project's findings. Each finding can carry Level, Source (Other, Analyzer, Validator, or Compiler), ErrorCode, RuleName, Description, FilePath, ActivityIdRef, and DocumentationLink.

Data.Projects is omitted when the failure belongs to no project.

--project:

{
  "Code": "SolutionPack",
  "Data": {
    "Package": "Acme.MyProcess@1.2.0",
    "Packages": "/home/me/dist/Acme.MyProcess.1.2.0.nupkg"
  }
}

• Package — <package-id>@<version> of the packed project.
• Packages — absolute path of the .nupkg.

プロジェクトの種類

Pack hands each member project to the packager tool for its project type. Some project types have their own pack behavior:

projectType	Pack behavior
フロー	The .flow file is checked against the Maestro designer's validation rules. A flow with errors fails the pack. Every issue, warnings included, is reported as a finding, with ActivityIdRef naming the node.
ビジネス ルール	Packed as a .uirule archive named <rule-name>-<version>.uirule, holding the rule's .dmn files and an entry-points.json derived from them.
Data Fabric entities	Validated only: pack checks that every entity definition is intact and its schema is valid. The entity definition resources are the deployable payload, so no separate package is produced for the project.

故障モード

• --project that does not resolve. A project Id or path that is not in the .uipx, that matches more than one project, that points outside the solution folder, or that sits at the solution root is refused with ErrorCode: invalid_argument. The message lists the solution's project Id values and paths to pick from.
• --project with a .uis file, or with --name. Refused: --project packs a project out of a solution folder, and --name names the solution .zip that --project does not produce. --package-id names the project package.
• --package-id without --project, or an empty --project or --package-id. Refused.
• --dry-runなしでoutputPathが欠落しています。出力ディレクトリを指定するか、 を渡すためのポインターで失敗 --dry-run。
• Empty governance flag value. An empty value for --governance-file-path or --governance-product is rejected.
• Unusable governance policy file. A --governance-file-path file that cannot be read or is not JSON fails the pack. So does a file that holds only the inner policy of an AutomationOps export; pass the exported file as-is.
• Member package ID collision. A member's package ID is composed as <solution>.<project-type>.<member-folder>, capped at 100 characters, and must be unique across the solution. Spaces and dots collapse to a single dot, and IDs are compared case-insensitively. When two members compose the same ID, the pack fails with ErrorCode: invalid_argument, naming the ID and the folders that produced it. The <solution> part is the .uipx file's own name; --name renames the archive only and does not change member IDs. Rename the member folder or the .uipx, then pack again.
• Project failure. A project that fails compilation, validation, or analysis fails the pack. Data.Projects names the project and its findings.
• メンバー プロジェクト ディレクトリ内の出力パスです。拒否された — そこに書かれたものはすべて、次のパックでそのプロジェクト独自のパッケージに詰め込まれます。ソリューションのプロジェクト ディレクトリの外部にある出力パスを選択します (たとえば、ソリューションのルートにある ./out 、またはソリューションの完全な外部にあるディレクトリ)。
• アンパック可能なプロジェクトの種類。プロジェクトの種類に名前を付け、 uip tools search / uip tools install <tool> をポイントして、そのパッケージを処理するパッケージャー ツールを追加します (新しく追加された種類の場合は最初に uip update します)。

関連コマンド

• uip solution publish — パッケージ化された.zipをテナントのソリューション フィードにアップロードします。
• uip solution upload — ソリューションをデプロイ用にパッケージ化するのではなく、対話型の編集用に Studio Web にアップロードする代替パスです。
• uip solution deploy run — パブリッシュされたパッケージを Orchestrator にデプロイします。

参照

• 最初のパイプライン — パック→パブリッシュ→デプロイの実行ウォークスルー。
• uip solutionの概要。