Como iniciadores e revisores realizam uma revisão de código - DataWorks: Central de Documentação do Alibaba Cloud

A revisão de código melhora a qualidade das tarefas de agendamento de produção ao exigir validação humana antes do deploy. Com a revisão obrigatória ativada, apenas as tarefas aprovadas podem ser implantadas no ambiente de produção.

Visão geral

No DataWorks, ative a revisão obrigatória de código para evitar falhas em tarefas causadas por código não compatível e prevenir o desperdício de recursos computacionais. Quando esse recurso está habilitado, os revisores devem verificar a qualidade do código das tarefas antes da implantação.

Revisão obrigatória desativada: Ao enviar um nó, você ainda pode iniciar manualmente uma revisão. No entanto, o nó pode ser implantado independentemente do resultado da revisão.
Revisão obrigatória ativada: Ao enviar um nó, selecione um revisor qualificado para revisar o código.
- Se a revisão for aprovada, o nó seguirá para envio e implantação.
- Caso a revisão não seja aprovada, o nó não poderá ser enviado nem implantado. Modifique o código com base nos comentários da revisão e inicie uma nova revisão. A implantação do nó só será permitida após a aprovação dessa nova revisão.

Além disso, ao processar um ticket de revisão, o revisor pode usar IA para analisar inteligentemente as alterações de código. Essa funcionalidade fornece rapidamente uma sugestão de conclusão da revisão, um resumo das alterações e uma lista de problemas para auxiliar na tomada de decisão manual. A IA oferece apenas sugestões; a decisão final sobre a aprovação cabe exclusivamente ao revisor.

Limitações

O recurso de revisão de código está disponível apenas no DataWorks Professional Edition ou superior. Certifique-se de ter activated DataWorks Professional Edition ou uma edição mais recente. Para obter mais informações sobre os recursos das diferentes edições, consulte DataWorks editions.
Somente uma conta Alibaba Cloud, um Workspace Administrator ou um usuário RAM com a permissão AliyunDataWorksFullAccess pode ativar ou desativar a revisão de código para um workspace. Para mais detalhes, consulte Users, roles, and permissions.
Não é possível iniciar uma revisão de código para tipos especiais de nós, como nós compostos (do-while e for-each), ou para arquivos de recursos que não sejam Python.

(Opcional) Administrador: Ativar revisão obrigatória de código

Um administrador de workspace pode ativar a revisão obrigatória de código na página de configurações do Data Studio.

Nota

Se a revisão obrigatória estiver desativada, você ainda poderá iniciar uma revisão, mas ela não bloqueará o processo de implantação.
A exclusão de um nó não aciona uma revisão de código no momento do envio.

Acessar Security Settings and Others

Acesse a página Workspaces no console do DataWorks. Na barra de navegação superior, selecione a região desejada. Localize o workspace apropriado e escolha Shortcuts > Data Studio na coluna Actions.
Navegue até a página de configurações do Data Studio.
1. No canto inferior esquerdo, clique em e selecione Data Studio Settings.
2. Vá para Security Settings and Others.
  
  Na página de configurações do Data Studio, alterne para a aba Security Settings and Others.

Ativar revisão de código

Na aba Security Settings and Others, ative Code Review > Mandatory Review.

Importante

Se você não encontrar a opção Mandatory Review na aba Security Settings and Others, verifique sua edição do DataWorks. O recurso de revisão de código está disponível apenas no DataWorks Professional Edition ou superior.

Parâmetro	Descrição
Mandatory Review	Define se uma revisão de código é necessária antes que as tarefas do workspace atual sejam implantadas no ambiente de produção.
Project Code Reviewer	Configure os revisores de código. Any Developer Role: Após o início de uma revisão de código para um nó, qualquer usuário com função de desenvolvedor no workspace pode ser selecionado para revisar o código. O revisor específico é determinado pela pessoa que implanta o nó. Specify development role users: Após o início de uma revisão de código para um nó, o envio e a implantação só ocorrem depois que os usuários especificados com funções de desenvolvedor aprovarem a revisão. Nota Apenas usuários com função de desenvolvedor no workspace atual podem ser selecionados como revisores. O DataWorks permite configurar um ou mais revisores de código. Quando há vários revisores configurados, a revisão é considerada aprovada assim que um deles a aprovar.
Specify Mandatory Code Review Baseline Scope	Determina quais nós exigem revisão de código ao serem enviados. É possível definir quais nós requerem revisão obrigatória com base na prioridade da baseline à qual pertencem: Quando o escopo de revisão de baseline está definido para tarefas sem baseline, todas as novas tarefas criadas no workspace atual exigem aprovação. Se o escopo de revisão de baseline estiver configurado para tarefas de baseline de um nível específico, os nós nessas baselines dentro do workspace atual exigirão aprovação no momento do envio. Um valor numérico maior para uma tarefa de baseline indica maior prioridade. Tarefas de baseline têm prioridade superior às tarefas sem baseline. Nota Ao selecionar tarefas sem baseline, todos os novos nós criados no workspace precisarão de aprovação.
Code Review Notification Method	Após ativar a revisão obrigatória, configure regras de notificação para garantir que as pessoas relevantes sejam avisadas automaticamente: Para revisores: quando uma nova tarefa de revisão é atribuída, o sistema envia uma notificação para alertar o revisor. Para remetentes: quando o status da revisão muda (como aprovado ou rejeitado), o remetente recebe uma notificação. Os seguintes métodos de notificação são suportados: SMS, DingTalk Group Robot Webhook, Mail, WeChat Group Webhook, Lark Webhook e Standard Webhook. Mensagens SMS de alerta e chamadas telefônicas provenientes da revisão de código consomem seus recursos de alerta. Verifique o uso na página Alert Resource no console de gerenciamento. Para mais informações, consulte View alert resource usage. Nota Standard Webhook está disponível apenas no DataWorks Enterprise Edition. A configuração de segurança de um robô de grupo do DingTalk suporta apenas verificação baseada em palavras-chave, e a palavra-chave deve conter `DataWorks`.

Iniciador da revisão: Iniciar uma revisão de código

O envio de um nó aciona uma revisão de código. Após selecionar um revisor, o sistema gera um ticket de revisão. Se a revisão obrigatória estiver ativada, a implantação será bloqueada na etapa de verificação de produção até que a revisão seja aprovada.

Nota

Se um nó já possui uma revisão de código em andamento e uma nova revisão for iniciada, o resultado da revisão anterior será invalidado automaticamente.
Excluir um nó não aciona uma revisão de código.

Implante a tarefa.
1. Clique em para salvar o nó de desenvolvimento de dados que deseja implantar e, em seguida, clique em para acessar a página Online publishing content.
2. Clique em Start Release Production para iniciar a implantação. Como a revisão obrigatória está ativada, o processo fica bloqueado na etapa de verificação de produção. O nó só poderá ser implantado após a aprovação da revisão de código.

Inicie uma revisão de código.

Clique em Initiate Code Review. Na página de configuração Code Review, configure Code Reviewer e Description of change.

Item de configuração	Descrição
Code Reviewer	Selecione o Project Code Reviewer configurado neste controle. É possível especificar um ou mais revisores de código.
Description of change	Descreva as alterações no código e outras informações relevantes.

Após concluir a configuração, clique em Confirm para enviar a revisão de código.

Revisor: Processar um ticket de revisão

Um revisor de código pode visualizar revisões pendentes e processar tickets em Code Review List > Reviewed by Me.

Acesse a página de revisão de código.

Clique em no painel de navegação à esquerda da página do Data Studio para ir até Code Review List > Reviewed by Me, onde estão listados os tickets de revisão de código atribuídos a você.
Processe um ticket de revisão de código.

Na página Code Review List > Reviewed by Me, visualize os detalhes da revisão e execute operações nos tickets.
- Na página da lista de revisões: Execute rapidamente as seguintes operações nos tickets: By, Reject, Abandoned, Reopen e Share.
- Na página de detalhes da revisão:
  1. Na página Code Review List > Reviewed by Me, clique em ticket de revisão desejado para acessar a página Code Review Details. Nela, compare as alterações no código e nas configurações de agendamento em relação à versão de produção e decida se aprova a revisão.
  2. Na seção de operações de revisão, o revisor pode executar as seguintes ações no ticket:
    - : Aprovar.
    - : Rejeitar.
    - : Abandonar.
    - : Reabrir.
    - Comments.
  Nota
  - Abandoned: Abandona a revisão atual. Após o abandono, o nó pode ser enviado e implantado diretamente.
  - Reopen: Reabre uma revisão abandonada para uma nova avaliação.
  Após a conclusão da revisão de código, o iniciador pode visualizar os detalhes e gerenciar tickets na página Code Review List > Reviewed by Me.

Revisão inteligente por IA

O revisor pode utilizar IA para analisar inteligentemente as alterações atuais no código, obtendo rapidamente uma sugestão de conclusão da revisão, um resumo das mudanças e uma lista de problemas. A IA fornece apenas sugestões; a decisão final sobre a aprovação é sempre do revisor.

Gere uma sugestão de revisão por IA.

Na seção de operações de revisão, clique em ícone de revisão inteligente ao lado de Comment. A IA analisará as alterações atuais do código. Após a conclusão da análise, o painel Generated Result será exibido.
Visualize o resultado gerado.

O painel Generated Result contém:
- Sugestão de conclusão da revisão: A IA fornece uma recomendação de Recommend approval ou Recommend rejection.
- Resumo das alterações: Resume as principais mudanças no código e nas configurações de agendamento.
Processe o resultado gerado.
- Accept: Adota a sugestão da IA. O comentário da revisão é preenchido automaticamente na caixa de comentários e a conclusão da IA é sincronizada. Envie a revisão após confirmar.
- Regenerate: Reanalisa as alterações e gera uma nova sugestão de revisão.
- Reject: Descarta a sugestão da IA. O painel é recolhido e a revisão prossegue manualmente.

Iniciador da revisão: Visualizar resultados da revisão

O iniciador da revisão pode consultar os resultados e gerenciar tickets em Code Review List > Reviewed by Me > Created by Me.

Acesse a página de revisão de código.

Clique em no painel de navegação à esquerda da página do Data Studio para ir até a página de revisão de código, onde é possível visualizar os tickets Created by Me.
Confirme os resultados da revisão.

Na página Code Review List > Reviewed by Me > Created by Me, visualize os detalhes da revisão e execute operações nos tickets.
- Na página da lista de revisões: O iniciador pode verificar rapidamente os resultados e executar as seguintes operações: Abandoned, Reopen ou Share.
  
  Nota
  Após o abandono da revisão, a versão atual do nó deve ser enviada novamente para revisão ou o ticket deve ser reaberto antes que a implantação possa continuar.
- Na página de detalhes da revisão: Na página Code Review List > Reviewed by Me, clique em ticket de revisão correspondente para acessar a página Code Review Details, onde você pode decidir se deseja Reopen ou marcar como Abandoned a revisão de código.
Se a revisão não for aprovada, o nó não poderá ser enviado nem implantado. Modifique o código com base nos comentários da revisão e inicie uma nova revisão. A implantação do nó só será permitida após a aprovação dessa nova revisão.

Próxima etapa

Após a aprovação da revisão de código, prossiga com a implantação. Caso a revisão não seja aprovada, ajuste o código conforme os comentários recebidos e inicie uma nova revisão.