Você está aqui:
Início rápido: Usar o Salesforce CLI com o DevOps Center
Use o Salesforce CLI para automatizar tarefas do DevOps Center na linha de comando. Nesse início rápido, você cria e ativa um pipeline, gerencia um item de trabalho e promove alterações para o próximo estágio do pipeline.
Edições obrigatórias
| Disponível em: Lightning Experience nas edições Professional (exige acesso à API), Enterprise, Performance, Unlimited e Developer Editions |
| Não disponível em: Government Cloud Plus. Entre em contato com seu executivo de conta do Salesforce para obter mais detalhes. |
| Não disponível em: Zona de operação da UE. A zona de operação da UE é uma oferta paga especial que proporciona um nível maior de compromisso de residência de dados. O DevOps Center tem suporte em organizações na UE que não fazem parte do OZ da UE, de acordo com os termos e condições padrão do produto. |
| Permissões de usuário necessárias | |
|---|---|
| Para criar um pipeline: | Administrador do DevOps Center |
| Para promover alterações pelo pipeline: | Gerente de implementação do DevOps Center |
Para ver todos os sinalizadores e opções disponíveis, consulte Referência de comando do Salesforce CLI.
Antes de começar, conclua estas tarefas.
- Instale o Salesforce CLI. Consulte Instalar Salesforce CLI.
- Instale o plugin DevOps Center.
sf plugins install @salesforce/plugin-devops-center - Autenticar para a organização em que o DevOps Center está disponível. Esse início rápido usa
my-devops-orgcomo o alias da organização.sf org login web --alias my-devops-org - Crie um projeto do DevOps Center na UI.
- Conecte o repositório do GitHub (ou Bitbucket) à sua organização DevOps Center.
- Defina a organização autenticada como a organização padrão.
sf config set target-org=my-devops-orgConfigurar a organização de destino omite
--target-org my-devops-orgde comandos subsequentes. Esse início rápido inclui o sinalizador em cada comando para que a organização de destino fique clara.
Configurar um pipeline
Crie um pipeline, adicione e configure seus estágios, ative o pipeline e anexe seu projeto.
-
Liste seus projetos para localizar o ID do projeto.
sf devops project list --target-org my-devops-orgCopie o ID do projeto que você deseja anexar ao pipeline. Os exemplos neste início rápido usam
0Hn000000000001. -
Crie um pipeline inativo e conecte-o ao seu repositório.
sf devops pipeline create --target-org my-devops-org --name "Release Pipeline" --repo https://github.com/myorg/myrepoCopie o ID do pipeline da saída do comando. Os exemplos neste início rápido usam
0XB000000000001.O pipeline permanece inativo até que você configure seus estágios e o ative.
Para criar um repositório ao criar o pipeline, use
--create-repocom--repo-type github|bitbucket. -
Adicione estágios ao seu pipeline. Um novo pipeline inclui um estágio final padrão. Adicione cada novo estágio antes de um estágio existente especificando esse estágio existente com
--next-stage-id.Por exemplo, adicione um estágio de integração.
sf devops pipeline stage add --target-org my-devops-org --pipeline-id 0XB000000000001 --name "Integration" --next-stage-id 0Xc000000000001Copie o ID do estágio da saída do comando. Os exemplos restantes utilizam
0Xc000000000005para a fase de integração. Repita o comando para cada estágio adicional, como UAT.
Dica Visualize seu pipeline na interface do usuário do DevOps Center para obter os IDs de estágio para comandos subsequentes. Ou executesf devops pipeline get --pipeline-id 0XB000000000001. -
Configure cada estágio. Cada estágio requer uma ramificação e um ambiente. Configure os estágios da direita para a esquerda, pois o estágio final deve ter uma ramificação para que você possa configurar os estágios antes dele.
Adicione uma ramificação ao estágio de Integração. O sinalizador de
--create-vcs-branchcria a ramificação no repositório se ela não existir.sf devops stage branch add --target-org my-devops-org --pipeline-id 0XB000000000001 --stage-id 0Xc000000000005 --branch-name integration --create-vcs-branchAdicione um ambiente de sandbox ao estágio.
sf devops stage environment add --target-org my-devops-org --pipeline-id 0XB000000000001 --stage-id 0Xc000000000005 --environment-name Integration_Org --org-type SandboxUma janela do navegador é aberta para que você possa se autenticar no ambiente. Use
--org-type Productionpara organizações de produção. Em um ambiente autônomo, adicione--no-browsere siga as instruções de autenticação retornadas pelo comando.Repita os comandos de ramificação e ambiente para cada estágio. Use o nome da agência, o nome do ambiente e o tipo de organização apropriado para cada estágio.
-
Ative o pipeline.
Importante Não é possível modificar o estágio do pipeline depois de promover alterações por meio dele. Certifique-se de que todos os estágios estejam configurados corretamente antes de executar esse comando.sf devops pipeline update --target-org my-devops-org --pipeline-id 0XB000000000001 --activate -
Anexe seu projeto do DevOps Center ao pipeline.
sf devops pipeline project add --target-org my-devops-org --pipeline-id 0XB000000000001 --project-id 0Hn000000000001O pipeline está pronto. Crie itens de trabalho na IU do DevOps Center ou execute o comandosf devops work-item create.
Gerenciar um item de trabalho
Conclua um ciclo de desenvolvimento iniciando um item de trabalho, confirmando suas alterações, criando uma revisão e marcando o item de trabalho como pronto para promoção.
Você pode passar --work-item-id em vez de --work-item-name em todos os comandos de item de trabalho e revisão.
-
Defina o status do item de trabalho como Em andamento. O DevOps Center cria uma ramificação de recurso para o item de trabalho.
sf devops work-item update --target-org my-devops-org --work-item-name WI-000042 --status "In Progress" -
Recupere a ramificação do recurso do repositório conectado e verifique-a em seu projeto local.
git fetch origin git checkout WI-000042 -
Recupere as alterações da sua organização de desenvolvimento. Este exemplo recupera uma classe do Apex da organização com o alias
my-sandbox.sf project retrieve start --target-org my-sandbox --metadata ApexClass:MyNewClass -
Revise os arquivos recuperados, prepara-os, confirme-os e envie por push a ramificação do recurso.
git status git add force-app git commit -am "Implement new feature" git push origin WI-000042Ajuste o caminho passado para
git addse o projeto do Salesforce DX usar um diretório de pacote diferente. -
Crie uma solicitação de alteração (solicitação de pull) para mesclar a ramificação de recurso na ramificação de destino.
sf devops review create --target-org my-devops-org --work-item-name WI-000042 - Aguarde sua equipe aprovar e mesclar a solicitação de alteração.
-
Atualize o status do item de trabalho para indicar que ele está pronto para promoção.
sf devops work-item update --target-org my-devops-org --work-item-name WI-000042 --status "Ready to Promote"
Promover um item de trabalho
Promova o item de trabalho para o próximo estágio do pipeline. O DevOps Center valida a promoção, executa os pacotes de teste configurados para o estágio de destino e implementa as alterações se os testes forem aprovados.
-
Promova o item de trabalho usando o ID do item de trabalho e o ID do estágio de destino.
sf devops promote --target-org my-devops-org --work-item-id 0Wx000000000042 --target-stage-id 0Xc000000000002A saída do comando inclui um ID de solicitação. Use-o para verificar o status da promoção.
Status: Completed Message: Work items successfully promoted to UAT. Request ID: a0B000000000001 Promoted Work Items ─────────────────── 0Wx000000000042 -
Use o ID da solicitação para verificar o status da promoção.
sf devops request status --target-org my-devops-org --request-token a0B000000000001
Quando o status da solicitação é concluído, o item de trabalho fica disponível no estágio de destino.
Tarefas comuns
Use esses comandos durante seu fluxo de trabalho de desenvolvimento diário.
-
Promova vários itens de trabalho para o mesmo estágio. Especifique a
--work-item-iduma vez para cada item de trabalho.sf devops promote --target-org my-devops-org --work-item-id 0Wx000000000042 --work-item-id 0Wx000000000043 --target-stage-id 0Xc000000000002 -
Implemente alterações mescladas externamente em um estágio fora de sincronia com o DevOps Center.
sf devops promotion complete --target-org my-devops-org --target-stage-id 0Xc000000000002
Casos de uso avançados
Depois de concluir o fluxo de trabalho básico, use estes comandos para promoções que exigem mais controle.
- Promoções personalizadas: Execute
sf devops work-item preparepara criar as ramificações e solicitações de alteração necessárias e, em seguida, promover o item de trabalho. - Combinar itens de trabalho: Execute
sf devops work-item combinequando vários itens de trabalho compartilham metadados ou têm dependências e precisam ser promovidos juntos. - Validar antes de promover: Execute
sf devops promotion validatepara verificar o controle de versão e as permissões de objeto sem promover os itens de trabalho.
