GitHub Actions disponíveis para desenvolvimento do Microsoft Power Platform

As seções a seguir descrevem GitHub Actions para Microsoft Power Platform. As seções também mostram fluxos de trabalho de GitHub de exemplo. Para obter mais informações sobre GitHub Actions e como baixá-los, consulte GitHub Actions para Microsoft Power Platform.

Configure as credenciais a serem usadas com o GitHub Actions no Microsoft Power Platform

Muitas das ações exigem que você se conecte a um ambiente do Microsoft Dataverse. Adicione credenciais de entidade de serviço ou de usuário como segredos em seu repositório GitHub e, em seguida, use-as em seus fluxos de trabalho.

Depois de configurar as credenciais, você pode chamar o service principal de dentro de seus scripts de Ação.

Defina os seguintes parâmetros em seu script de ação GitHub como variáveis de ambiente:

  • ID do aplicativo, como: WF_APPLICATION_ID:<your application id>
  • ID do locatário, como: WF_TENANT_ID:<your tenant id>

Adicione o segredo do cliente como um segredo GitHub. Faça referência a ele de dentro do fluxo de trabalho usando um parâmetro como: client secret: ${{secrets.CLIENT_SECRET_GITHUB_ACTIONS}}

Tarefas do assistente

A tarefa auxiliar a seguir está disponível.

actions-install

Quando um fluxo de trabalho GitHub Actions força uma instalação da CLI do Power Platform no contexto de um executor e ocorre um erro de tempo limite, use a versão 1 (@v1) com uma ação adicional (actions-install) conforme mostrado no exemplo a seguir.

Importante

  • O uso da versão 1 (@v1) pode levar a atualizações para ações existentes do GitHub que podem resultar na atualização dos fluxos de trabalho atuais.
  • Adicione a tarefa Instalar Ferramentas do Power Platform como a primeira tarefa em seu fluxo de trabalho antes de quaisquer outras GitHub Actions para o 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'

Você pode encontrar mais exemplos de GitHub Actions no Power Platform Actions.

whoAmI

Verifica a conexão do serviço conectando-se ao serviço e enviando uma solicitação da WhoAmI [API Web/SDK]. Essa tarefa pode ser útil para incluir no início do seu fluxo de trabalho do GitHub para verificar a conectividade antes do início do processamento.

Parâmetro Descrição
environment-url A URL do ambiente ao qual você está se conectando.
user-name O nome de usuário da conta que você está usando para se conectar.
password-secret A senha de user-name. Defina as senhas do GitHub em Configurações em Segredos. Você não pode recuperar um segredo depois de defini-lo e salvá-lo.
app-id A ID do aplicativo para autenticação. Este parâmetro é obrigatório durante a autenticação com credenciais da entidade de serviço.
client-secret O segredo do cliente usado para autenticar o pipeline do GitHub. Este parâmetro é obrigatório durante a autenticação com credenciais da entidade de serviço.
tenant-id A ID do locatário durante a autenticação com app-id e client-secret.

Tarefas da solução

Essas tarefas executam ações em soluções e incluem o seguinte.

import-solution

Importa uma solução para um ambiente de destino.

Parâmetro Descrição
environment-url (Obrigatório) A URL do ambiente de destino para onde você quer importar a solução (por exemplo, https://YourOrg.crm.dynamics.com).
user-name (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, o nome de usuário da conta que você está usando para se conectar.
password-secret (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, a senha da conta que você está usando para se conectar.
solution-file (Obrigatório) O caminho e o nome do arquivo de solução que você deseja importar.
app-id O ID do aplicativo usado para autenticação. Este parâmetro é obrigatório durante a autenticação com credenciais da entidade de serviço.
client-secret O segredo do cliente usado para autenticar o pipeline do GitHub. Este parâmetro é obrigatório durante a autenticação com credenciais do Service Principal.
tenant-id A ID do locatário durante a autenticação com app-id e client-secret.

export-solution

Exporta uma solução de um ambiente de origem.

Parâmetro Descrição
environment-url (Obrigatório) A URL do ambiente de onde você quer exportar a solução (por exemplo, https://YourOrg.crm.dynamics.com).
user-name (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, o nome de usuário da conta que você está usando para se conectar.
password-secret (Obrigatório) Se você estiver usando autenticação de nome de usuário/senha, a senha de user-name. Defina as senhas do GitHub em Configurações em Segredos. Você não pode recuperar um segredo depois de defini-lo e salvá-lo.
app-id A ID do aplicativo para autenticação. Este parâmetro é obrigatório durante a autenticação com credenciais da entidade de serviço.
client-secret O segredo do cliente usado para autenticar o pipeline do GitHub. Este parâmetro é obrigatório durante a autenticação com credenciais da entidade de serviço.
tenant-id A ID do locatário durante a autenticação com app-id e client-secret.
solution-name (Obrigatório) O nome da solução a ser exportada. Sempre use o nome da solução e não seu nome de exibição.
solution-output-file (Obrigatório) O caminho e o nome do arquivo solution.zip para o qual exportar o ambiente de origem.
gerenciado (Obrigatório) Defina como verdadeiro para exportar como solução gerenciada; o padrão (falso) é exportar como uma solução não gerenciada.

unpack-solution

Recebe um arquivo de solução compactado e o decompõe em vários arquivos XML. Você pode ler e gerenciar esses arquivos com mais facilidade em um sistema de controle do código-fonte.

Parâmetro Descrição
solution-file (Obrigatório) O caminho e o nome do arquivo solution.zip a ser descompactado.
solution-folder (Obrigatório) O caminho e a pasta de destino em que você deseja desempacotar a solução.
solution-type (Obrigatório) O tipo de solução que você deseja descompactar. As opções incluem Não gerenciado (recomendado), Gerenciado e Ambos.

pack-solution

Empacota uma solução representada no controle do código-fonte em um arquivo de solution.zip que você pode importar para outro ambiente.

Parâmetro Descrição
solution-file (Obrigatório) O caminho e o nome do arquivo solution.zip no qual empacotar a solução (por exemplo, out/CI/ALMLab.zip).
solution-folder (Obrigatório) O caminho e a pasta de origem da solução a ser empacotada.
solution-type (Opcional) O tipo de solução a empacotar. As opções incluem Não gerenciado (recomendado), Gerenciado e Ambos.

publish-solution

Publica as personalizações da solução.

Parâmetro Descrição
environment-url (Obrigatório) A URL do ambiente de destino onde você quer publicar a solução (por exemplo, https://YourOrg.crm.dynamics.com).
user-name (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, o nome de usuário da conta que você está usando para se conectar.
password-secret (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, a senha da conta que você está usando para se conectar.
solution-file (Obrigatório) O caminho e o nome do arquivo de solução que você deseja importar.
app-id A ID do aplicativo para autenticação. Este parâmetro é obrigatório durante a autenticação com credenciais da entidade de serviço.
client-secret O segredo do cliente usado na autenticação do pipeline do GitHub. Este parâmetro é obrigatório durante a autenticação com credenciais do Service Principal.
tenant-id A ID do locatário durante a autenticação com app-id e client-secret.

clone-solution

Clona a solução para um determinado ambiente.

Parâmetro Descrição
environment-url (Obrigatório) A URL do ambiente de onde você quer clonar a solução (por exemplo, https://YourOrg.crm.dynamics.com).
user-name (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, o nome de usuário da conta que você está usando para se conectar.
password-secret (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, a senha da conta que você está usando para se conectar.
solution-file (Obrigatório) O caminho e o nome do arquivo de solução que você deseja importar.
app-id O ID do aplicativo usado para autenticar. Este parâmetro é obrigatório durante a autenticação com credenciais da entidade de serviço.
client-secret O segredo do cliente usado para autenticar o pipeline do GitHub. Este parâmetro é obrigatório durante a autenticação com credenciais da entidade de serviço.
tenant-id A ID do locatário durante a autenticação com app-id e client-secret.
solution-name (Obrigatório) O caminho e o nome do arquivo solution.zip necessários para clonagem (por exemplo, out/CI/ALMLab.zip).
solution-version A versão da solução a ser clonada.
target-folder Pasta de destino na qual a solução extraída deve ser colocada. (por exemplo, Git repository\target-solution-folder).
Diretório de trabalho Pasta temporária para artefatos de trabalho em andamento necessários para clonar a solução.
padrão: root of the repository

check-solution

Verifica o arquivo da solução para detectar inconsistências.

Parâmetro Descrição
environment-url (Obrigatório) A URL do ambiente de onde você quer clonar a solução (por exemplo, https://YourOrg.crm.dynamics.com).
user-name (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, o nome de usuário da conta que você está usando para se conectar.
password-secret (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, a senha da conta que você está usando para se conectar.
app-id A ID do aplicativo para autenticação. Este parâmetro é obrigatório durante a autenticação com credenciais de Service Principal.
client-secret O segredo do cliente usado para autenticar o pipeline do GitHub. Este parâmetro é obrigatório durante a autenticação com credenciais do Service Principal.
tenant-id A ID do locatário durante a autenticação com app-id e client-secret.
caminho (Obrigatório) O caminho e o nome do arquivo de solução que você deseja verificar.
área geográfica Qual localização geográfica do serviço Verificador do Microsoft Power Platform usar. O valor padrão é 'united states'.
rule-level-override Caminho de um arquivo que contém uma matriz JSON de regras e os níveis. Os valores aceitos são: Critical, High, Low e Informational. Exemplo: [{"Id":"meta-remove-dup-reg","OverrideLevel":"Medium"},{"Id":"il-avoid-specialized-update-ops","OverrideLevel":"Medium"}]
checker-logs-artifact-name O nome da pasta de artefato na qual os logs do verificador do Microsoft Power Platform serão enviados. O valor padrão é 'CheckSolutionLogs'.

upgrade-solution

Fazer upgrade da solução.

Parâmetro Descrição
environment-url (Obrigatório) A URL do ambiente de onde você quer clonar a solução (por exemplo, https://YourOrg.crm.dynamics.com).
user-name (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, o nome de usuário da conta que você está usando para se conectar.
password-secret (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, a senha da conta que você está usando para se conectar.
solution-file (Obrigatório) O caminho e o nome do arquivo de solução que você deseja importar.
app-id A ID do aplicativo para autenticação. Este parâmetro é obrigatório durante a autenticação com credenciais da entidade de serviço.
client-secret O segredo do cliente usado na autenticação do pipeline do GitHub. Este parâmetro é obrigatório durante a autenticação com credenciais da entidade de serviço.
tenant-id A ID do locatário durante a autenticação com app-id e client-secret.
solution-name (Obrigatório) Nome da solução a ser atualizada.
assíncrono Faz upgrade da solução de maneira assíncrona.
max-async-wait-time Tempo de espera assíncrono máximo em minutos. O valor padrão é 60 minutos.

Tarefas do pacote

Essas tarefas executam ações em relação a pacotes.

deploy-package

Implanta uma DLL de pacote ou um arquivo ZIP com um pacote.

Nota

Essa ação só é compatível com o Windows.

Parâmetro Descrição
environment-url (Obrigatório) A URL do ambiente de onde você quer clonar a solução (por exemplo, https://YourOrg.crm.dynamics.com).
user-name (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, o nome de usuário da conta que você está usando para se conectar.
password-secret (Obrigatório) Se você estiver usando autenticação com nome de usuário/senha, a senha da conta que você está usando para se conectar.
app-id O ID do aplicativo usado para autenticação. Este parâmetro é obrigatório durante a autenticação com credenciais do Service Principal.
client-secret O segredo do cliente usado na autenticação do pipeline do GitHub. Este parâmetro é obrigatório durante a autenticação com credenciais da entidade de serviço.
tenant-id A ID do locatário durante a autenticação com app-id e client-secret.
pacote (Obrigatório) O caminho da dll do pacote ou do arquivo DLL or ZIP com um pacote.

Tarefas do portal

Essas tarefas executam as ações a seguir em portais do Power Pages.

upload-paportal

Faz upload de dados para o Power Pages.

Parâmetro Descrição
environment-url (Obrigatório) A URL do ambiente para onde você quer importar a solução (por exemplo, https://YourOrg.crm.dynamics.com).
app-id O ID do aplicativo usado para autenticação. Este parâmetro é obrigatório durante a autenticação com credenciais da entidade de serviço.
client-secret O segredo do cliente usado para autenticar o pipeline do GitHub. Este parâmetro é obrigatório durante a autenticação com credenciais do Service Principal.
tenant-id A ID do locatário durante a autenticação com app-id e client-secret.
upload-path Caminho onde o conteúdo do site é armazenado (alias: -p).
deployment-profile Carregue os dados do portal com detalhes do ambiente definidos por meio de variáveis de perfil no arquivo deployment-profiles/[profile-name].deployment.yaml.
model-version Indica se os dados do site a serem carregados usam o modelo de dados padrão (1) ou aprimorado (2). O valor padrão é 1.

Saiba mais sobre o suporte ao Microsoft Power Platform CLI para Power Pages.

Tarefas do catálogo (versão preliminar)

Essas tarefas executam ações em relação ao catálogo na Power Platform.

Nota

Atualmente, as tarefas de catálogo do Power Platform estão em versão prévia.

instalar

Instale um item do catalog no ambiente de destino.

Parâmetro Descrição
catalog-item-id (Obrigatório) Item de catálogo a ser instalado no ambiente de destino.
target-url (Obrigatório) A URL do ambiente de destino para a instalação do item de catálogo (por exemplo, https://YourOrg.crm.dynamics.com).
configurações (Obrigatório) Configurações do pacote de runtime para a estrutura de instalação a ser executada. O formato da cadeia de caracteres deve ser key=value|key=value.
target-version A versão alvo a ser instalada. Se você não especificar uma versão, a versão publicada será selecionada.
poll-status Consulte para verificar o status da sua solicitação.

enviar

Liste todos os itens do catálogo publicados do ambiente atual do Dataverse (organização).

Parâmetro Descrição
caminho (Obrigatório) Caminho para o documento de envio do catálogo.
package-zip Caminho para o arquivo .zip do pacote.
solution-zip Caminho para o arquivo ZIP da solução.
poll-status Vote para verificar o status de sua solicitação.

status

Obtenha o status da solicitação de instalação ou envio do catálogo.

Parâmetro Descrição
tracking-id (Obrigatório) Solicite a ID de rastreamento.
tipo (Obrigatório) Tipo de solicitação. Os valores válidos são Install e Submit.

Criação de fluxos de trabalho no GitHub

Para saber mais sobre como compor fluxos de trabalho do GitHub usando GitHub Actions, conclua os laboratórios do GitHub Actions para Microsoft Power Platform.

Para obter mais informações, consulte Sobre GitHub Actions.

Consulte também

Ações do GitHub para Microsoft Power Platform