UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Pacote de solução uip

Sintaxe e opções para o "uip solution package", que produz um arquivo `.zip` implantável a partir de um diretório de soluções ou arquivo de pacote `.uis`.

produz um pacote uip solution pack .zip a partir de um diretório de soluções (contendo um manifesto .uipx ) ou de um arquivo pacote .uis . O arquivo resultante é o que uip solution publish carrega no feed do tenant, que uip solution deploy run pode implantar.

Pacote é uma operação offline — ele não entra em contato com o Orchestrator, exceto para resolver dependências NuGet de feeds de tenants (ou um feed de biblioteca da pasta do Orchestrator por meio de --feed-folder) e não entra em contato com AutomationOps, exceto quando um sinalizador de governança ou --ignored-rules é passado enquanto você estão conectados — portanto, é seguro executar etapas de compilação que ainda não têm credenciais completas, desde que a resolução de dependência esteja coberta.

Resumo​

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>]
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>]

O comando honra as opções globais e retorna os códigos de saída padrão.

Argumentos​

  • <solutionPath> (necessário) — Caminho para um diretório de solução (contendo um manifesto .uipx ) ou um arquivo .uis .
  • [outputPath] opcional) — Diretório de saída onde o pacote .zip será escrito. Obrigatório, a menos que --dry-run esteja definido — omiti-lo sem --dry-run falha com um ponteiro para adicionar um ou outro.

Opções​

LongValorPadrãoDescription
-n, --name <name>textnome da pasta da solução (ou nome base do arquivo .uis)Nome do pacote. O .zip empacotado é nomeado <name>_<version>.zip.
-v, --version <version>text1.0.0Versão do pacote. Aparece no nome do arquivo de saída e é o valor passado para --package-version em deploy run.
--project <id-or-path>projeto Id ou caminho—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>texto id que um pacote de solução completa dá ao projetoID do pacote para o projeto empacotado com --project. Sem ele, o projeto mantém o id que um pacote de solução completa proporciona a ele: aquele que a solução salvou, então <solution>.<type>.<project folder>. Requer --project.
--dry-runBandeiradesativadaExecute o pipeline completo do pacote (sincronização de recursos, emissão de dependência de runtime, validação de opções do empacotador) em uma cópia temporária descartável e descarte a saída. Pega falhas de tempo de empacotamento — uma dependência ausente, uma associação de recurso quebrada, um tipo de projeto desempacotado — sem produzir um .zip ou escrever qualquer coisa de volta na solução. Ele não inspeciona o conteúdo do pacote produzido, portanto, não pode garantir que o feed da solução aceitará o resultado. Torna [outputPath] opcional.
--login-validity <minutes>minutos10Mínimo de minutos antes da expiração do token para disparar uma atualização. Relevante apenas quando a resolução de dependência precisa de um feed de tenant ou quando a política de governança do tenant é verificada.

Resolução de dependência​

LongValorPadrãoDescription
--nuget-sources-config-path <path>Path—Caminho para um arquivo de configuração de origens do NuGet para resolver dependências do projeto.
--exclude-configured-sourcesBandeiradesativadaResolver dependências apenas de feeds de tenant e --nuget-sources-config-path. Solta os feeds UiPath e nuget.org integrados — uma dependência fora desses feeds não será restaurada.
--feed-folder <name>Nome ou caminho—Resolva dependências do feed de biblioteca desta pasta do Orchestrator em vez de cada feed de tenant. Aceita um nome de pasta ou caminho totalmente qualificado.

Análise de governança​

--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.

LongValorPadrãoDescription
--skip-analyzeBandeiradesativadaIgnorar o analisador de fluxo de trabalho para todos os projetos de RPA. Compilação e validação ainda em execução — apenas as regras do analisador são ignoradas.
--ignored-rules <rules>IDs de regras separados por vírgulas—IDs de regra do analisador cujas descobertas são ignoradas para cada projeto de RPA, por exemplo ST-USG-034,ST-MRD-002 Repita o sinalizador para adicionar mais. As regras ainda são executadas, mas suas descobertas não são relatadas e não falham no pacote. Aplica-se sobre --governance-file-path ou às regras enviadas. Quando o tenant conectado publica uma política do AutomationOps, a lista não é aplicada e um aviso diz isso.
--governance-file-path <path>Path—Analise cada projeto de RPA em relação a este arquivo de política de governança local em vez das regras do analisador fornecido com o WorkflowCompiler. Aceita uma política exportada do AutomationOps ou de um arquivo de configuração de regras do Studio. Quando você estiver conectado, o tenant será perguntado primeiro (sobre StudioWeb, a menos que --governance-product nomeie outro produto). Quando o tenant publica uma política própria, essa política é usada, esse arquivo é ignorado com um aviso e o pacote continua. Quando o tenant não publica nenhuma política, quando não pode ser solicitado ou quando seu serviço de política não responde, esse arquivo é usado. O arquivo é lido antes que o tenant seja solicitado, portanto, um arquivo ilegível ou não JSON falha no pacote em todos os casos.
--governance-product <product>text—Analise cada projeto de RPA em relação à política de governança publicada no AutomationOps para o tenant conectado. O valor é o produto cuja política é baixada — por exemplo, StudioWeb, Development, Business.

Um valor vazio para qualquer sinalizador de governança (--governance-file-path "") é rejeitado como um erro, e não é tratado silenciosamente como "sem sinalizador".

Assinatura do pacote​

A assinatura do .nupkg de um projeto já empacotado requer a CLI dotnet em PATH.

LongValorPadrãoDescription
--signing-certificate-path <path>Path—Caminho para um certificado de assinatura de código .pfx. Quando definido, cada projeto empacotado .nupkg na solução é assinado antes de ser agrupado na solução .zip.
--signing-certificate-password <password>texto ou env.VAR—Senha do certificado. Passe env.ENV_NAME para ler uma variável de ambiente em vez do histórico do shell.
--signing-timestamp-server <url>URL—URL do servidor de carimbo de data/hora para a assinatura.

Metadados do pacote (rastreabilidade da origem)​

Esses sinalizadores marcam metadados de rastreabilidade em um arquivo package.metadata.json na raiz do arquivo e em cada projeto. .nuspec Nenhum é necessário. Quando --author ou --description é omitido, cada projeto membro mantém o valor que seu próprio arquivo de projeto declara e retorna para UiPath / Created by UiPath quando não declara nenhum.

LongValorPadrãoDescription
--author <text>textpróprio autor de cada projeto, caso contrário UiPathAutor do pacote. Quando definido, aplica-se a todos os projetos membros.
--description <text>texta própria descrição de cada projeto, caso contrário Created by UiPathDescrição do pacote. Quando definido, aplica-se a todos os projetos membros.
--release-notes <text>text—Notas de versão para o pacote.
--project-url <url>URL—URL da ideia do Automation Hub.
--repository-url <url>URL—URL do repositório de origem.
--repository-commit <sha>text—Hash de confirmação do repositório de origem.
--repository-branch <branch>text—Ramificação do repositório de origem.
--repository-type <type>textgit (quando --repository-url está definido)Tipo de repositório de origem. Gravado apenas quando --repository-url também está definido.

Exemplos​

Mínimo​

uip solution pack ./my-solution ./dist
uip solution pack ./my-solution ./dist

Empacota a solução em ./my-solution em ./dist/my-solution_1.0.0.zip (versão padrão).

Comum — o nome fixo e a versão para uma compilação de CI​

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

Grava ./dist/invoices_1.2.0.zip.

Validar sem empacotar​

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

Executa o pipeline completo do pacote em um diretório temporário e descarta a saída — útil como uma porta de pré-implantação no CI, pois captura erros de associação de recursos, referência de variável e dependência de runtime sem precisar de outputPath um.

Metadados de rastreabilidade de origem do carimbo​

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 \
  --repository-url https://github.com/acme/repo \
  --repository-commit abc123 \
  --repository-branch main \
  --release-notes "v1.2.0"

Assinar projetos empacotados​

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 \
  --signing-certificate-path ./cert.pfx \
  --signing-certificate-password env.UIPATH_SIGNING_CERTIFICATE_PASSWORD \
  --signing-timestamp-server http://timestamp.digicert.com

Ignorar o analisador de fluxo de trabalho​

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

Compilação e validação ainda em execução — apenas as regras do analisador são ignoradas.

Analisar com base em uma política de governança do tenant​

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

Ignorar regras específicas do analisador​

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

As regras ainda são executadas, mas suas descobertas não falham no pacote. A lista não é aplicada quando o tenant publica uma política do AutomationOps.

Empacotar um projeto​

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

--project produz o .nupkg do projeto em vez da solução .zip, por exemplo, para publicar um projeto em um feed do Orchestrator por conta própria. --name nomeia a solução .zip, portanto, não pode ser usada com --project; --package-id nomeia o pacote do projeto.

Scripting — capture o caminho de saída para a etapa de publicação​

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

Formato dos dados (--output json)​

Pacote real:

{
  "Code": "SolutionPack",
  "Data": {
    "Package": "my-solution@1.2.0",
    "Packages": "./dist/my-solution_1.2.0.zip"
  }
}
{
  "Code": "SolutionPack",
  "Data": {
    "Package": "my-solution@1.2.0",
    "Packages": "./dist/my-solution_1.2.0.zip"
  }
}
  • Package — identificador <name>@<version> para a solução empacotada.
  • Packages — lista separada por vírgulas de .zip caminho(s) escrito(s) para <outputPath>. Normalmente, um único caminho.

Simulação (--dry-run):

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

Quando o pacote falha e o empacotador relata resultados por projeto, o envelope de falha Data.Projects, uma entrada por projeto de membro:

CampoDescription
PathO diretório do projeto, relativo ao diretório da solução, com barras comuns.
TypeO tipo de projeto.
ResultSuccess ou Failure.
MessageA mensagem de resultado do projeto, quando tiver uma.
FindingsAs descobertas do projeto. Cada descoberta pode carregar Level, Source (Other, Analyzer, Validator ou Compiler), ErrorCode, RuleName, Description, FilePath, ActivityIdRef, e DocumentationLink.

Data.Projects é omitido quando a falha não pertence a nenhum projeto.

Com --project:

{
  "Code": "SolutionPack",
  "Data": {
    "Package": "Acme.MyProcess@1.2.0",
    "Packages": "/home/me/dist/Acme.MyProcess.1.2.0.nupkg"
  }
}
{
  "Code": "SolutionPack",
  "Data": {
    "Package": "Acme.MyProcess@1.2.0",
    "Packages": "/home/me/dist/Acme.MyProcess.1.2.0.nupkg"
  }
}
  • Package — <package-id>@<version> do projeto empacotado.
  • Packages — caminho absoluto de .nupkg.

Tipos de Projeto​

Empacotar entrega cada projeto de membro à ferramenta empacotador para seu tipo de projeto. Alguns tipos de projeto têm seu próprio comportamento do pacote:

Tipo de ProjetoComportamento das pacotes
FluxoO .flow é verificado em relação às regras de validação do designer do Maestro. Um fluxo com erros falha no pacote. Cada problema, incluindo avisos, é relatado como uma descoberta, com ActivityIdRef nomeando o nó.
Regras de NegóciosCompactado como um arquivo .uirule chamado <rule-name>-<version>.uirule, contendo os arquivos .dmn da regra e um entry-points.json derivados deles.
Entidades do Data FabricApenas validado: o pacote verifica se todas as definições de entidade estão intactas e se o esquema é válido. Os recursos de definição de entidade são a carga implantável, portanto, nenhum pacote separado é produzido para o projeto.

Modos de falha​

  • --project não resolve. Um projeto Id ou caminho que não está no .uipx, que corresponde a mais de um projeto, que aponta para fora da pasta da solução ou que fica na raiz da solução é recusado com ErrorCode: invalid_argument. A mensagem lista os valores Id do projeto da solução e caminhos para escolha.
  • --project com um arquivo .uis ou com --name. Recusado: --project empacota um projeto fora de uma pasta de solução e --name nomeia a solução .zip que --project não produz. --package-id nomeia o pacote do projeto.
  • --package-id sem --project, ou um --project ou --package-id vazio. Recusado.
  • outputPath ausente sem --dry-run. Falha com um ponteiro para fornecer um diretório de saída ou passar --dry-run.
  • Valor do sinalizador de governança vazio. Um valor vazio para --governance-file-path ou --governance-product é rejeitado.
  • Arquivo de política de governança inutilizável. Um arquivo --governance-file-path que não pode ser lido ou não é JSON falha no pacote. O mesmo acontece com um arquivo que contém apenas a política interna de uma exportação do AutomationOps; passe o arquivo exportado como está.
  • Colisão de IDs do pacote de membros. O ID do pacote de um membro é composto por <solution>.<project-type>.<member-folder>, limitado a 100 caracteres e deve ser exclusivo em toda a solução. Espaços e pontos são recolhidos para um único ponto, e os IDs são comparados sem diferenciação entre maiúsculas e minúsculas. Quando dois membros compões o mesmo ID, o pacote falha com ErrorCode: invalid_argument, nomeando o ID e as pastas que o produziram. A parte <solution> é o nome do próprio arquivo .uipx ; --name renomeia apenas o arquivo e não altera as IDs dos membros. Renomeie a pasta do membro ou .uipx e, em seguida, empacota novamente.
  • Falha no projeto. Um projeto que falha na compilação, validação ou análise falha no pacote. Data.Projects o projeto e suas descobertas.
  • Caminho de saída dentro de um diretório de projeto membro. Recusado — qualquer coisa escrita lá será empacotada no próprio pacote desse projeto no próximo pacote. Escolha um caminho de saída fora dos diretórios do projeto da solução (por exemplo, ./out na raiz da solução ou um diretório totalmente fora da solução).
  • Tipo de projeto desempacotado. Nomeia o tipo de projeto e aponta para uip tools search / uip tools install <tool> para adicionar a ferramenta de empacotamento que gerencia isso (ou uip update primeiro, se for um tipo recém-adicionado).
  • uip solution publish — carrega o .zip empacotado para o feed da solução do tenant.
  • uip solution upload — caminho alternativo que carrega a solução no Studio Web para edição interativa em vez de empacotá-la para implantação.
  • uip solution deploy run — implanta um pacote publicado no Orchestrator.

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte(opens in new window)

Quer aprender? Academia UiPath(opens in new window)

Tem perguntas? Fórum do UiPath(opens in new window)

Fique por dentro das novidades