A revisão de código melhora a qualidade das tarefas de agendamento de produção, pois exige avaliação humana antes da implantação. Com a revisão de código obrigatória ativada, somente as tarefas aprovadas na revisão seguem para implantação no ambiente de produção.
Visão geral
No DataWorks, ative a revisão de código obrigatória para evitar falhas em tarefas causadas por código em desconformidade e prevenir o desperdício de recursos de computação. Com esse recurso ativado, os revisores precisam 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 uma revisão manualmente. No entanto, o sistema implanta o nó independentemente do resultado da revisão.
-
Revisão obrigatória ativada: ao enviar um nó, selecione um revisor qualificado para avaliar o código.
Se a revisão for aprovada, o nó seguirá para envio e implantação.
Se a revisão não for aprovada, o sistema bloqueia o envio e a implantação do nó. Por favor, modifique o código com base nos comentários da revisão e inicie uma nova avaliação. O nó só segue para implantação após a aprovação da 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 e obter rapidamente uma sugestão de conclusão, um resumo das alterações e uma lista de problemas para auxiliar na tomada de decisão manual. A IA fornece apenas sugestões; o revisor toma a decisão final sobre a aprovação.
A página de detalhes da revisão de código também aceita comentários em nível de linha na visualização de diferenças (diff) das alterações de código e de configuração de agendamento. Revisores e solicitantes podem deixar comentários em linhas específicas do código ou em itens de configuração para tornar a discussão mais eficiente. As alterações de configuração de qualidade são somente leitura e não aceitam comentários em nível de linha.
Limitações
O recurso de revisão de código está disponível apenas no DataWorks Professional Edition ou superior. Certifique-se de ter o activated DataWorks Professional Edition ou uma edição superior. Para mais informações sobre os recursos das diferentes edições, consulte DataWorks editions.
Apenas 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 de um workspace. Para mais informações, consulte Overview of users, roles, and permissions.
O sistema não permite iniciar uma revisão de código para tipos de nós especiais, como nós compostos (do-while e for-each), nem para arquivos de recurso não Python.
(Opcional) Administrador: ative a revisão obrigatória de código
O administrador do workspace pode ativar a revisão de código obrigatória na página de configurações do Data Studio.
Se a revisão de código obrigatória estiver desativada, você ainda poderá iniciar uma revisão, mas ela não bloqueará o processo de implantação.
Excluir um nó não aciona uma revisão de código no 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. Encontre o workspace e escolha na coluna Actions.
-
Em seguida, acesse a página de configurações do Data Studio.
No canto inferior esquerdo, clique no ícone
e selecione Data Studio Settings.-
Em seguida, acesse Security Settings and Others.
Na página de configurações do Data Studio, clique na aba Security Settings and Others.
ative a revisão de código
Na aba Security Settings and Others, ative Code Review > Mandatory Review.
Se você não encontrar a opção Mandatory Review na aba Security Settings and Others, verifique a 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 | defina se a revisão de código é necessária antes da implantação das tarefas do workspace atual no ambiente de produção. |
Project Code Reviewer | configure os revisores de código.
Nota
|
Specify Mandatory Code Review Baseline Scope | defina quais nós exigem revisão de código no envio. Determine os nós que exigem revisão de código obrigatória com base na prioridade da baseline à qual pertencem:
Nota Ao selecionar tarefas sem baseline, todos os nós recém-criados no workspace exigem aprovação. |
Code Review Notification Method | Após ativar a revisão obrigatória, configure regras de notificação para alertar os responsáveis automaticamente:
Métodos de notificação compatíveis: SMS, DingTalk Group Robot Webhook, Mail, WeChat Group Webhook, Lark Webhook e Standard Webhook. As mensagens SMS de alerta e as chamadas telefônicas da revisão de código consomem recursos de alerta. visualize o uso na página Alert Resource no console de gerenciamento. Para mais informações, consulte View alert resource usage. Nota
|
Solicitante da revisão: Iniciar uma revisão de código
O sistema aciona uma revisão de código no envio de um nó. Após a seleção de um revisor, o sistema gera um ticket de revisão. Se a revisão de código obrigatória estiver ativada, a implantação fica bloqueada na etapa de verificação de produção até a aprovação da revisão.
Se um nó já possuir uma revisão de código em andamento e você iniciar uma nova, o sistema invalida automaticamente o resultado da anterior.
A exclusão de um nó não aciona uma revisão de código.
-
Implante a tarefa.
Clique no ícone
e salve o nó de desenvolvimento de dados a ser implantado. Em seguida, clique no ícone 
para acessar a página Online publishing content.clique em Start Release Production para iniciar a implantação. Como a revisão de código obrigatória está ativada, o processo fica bloqueado na etapa de verificação de produção. O nó só será implantado após a aprovação da revisão.
-
Inicie uma revisão de código.
Clique em Initiate Code Review. Na página de configuração Code Review, configure o Code Reviewer e a Description of change.
Item de configuração
Descrição
Code Reviewer
selecione o Project Code Reviewer configurado. Especifique 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 e envie a revisão de código.
Revisor: Processar um ticket de revisão
O revisor pode visualizar revisões pendentes e processar tickets em Code Review List > Reviewed by Me.
-
Em seguida, acesse a página de revisão de código.
Clique no ícone
no painel de navegação à esquerda do Data Studio para acessar Code Review List > Reviewed by Me e visualizar os tickets 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 de código e execute operações nos tickets.
Na página da lista de revisão de código: execute rapidamente as seguintes operações nos tickets: By, Reject, Abandoned, Reopen e Share.
-
Na página de detalhes da revisão de código:
Na página Code Review List > Reviewed by Me, clique no ticket desejado para acessar Code Review Details. visualize as alterações no código e nas configurações de agendamento em comparação com a versão de produção e decida se aprova a revisão.
-
Na seção de operações, execute as seguintes operações de revisão no ticket:
: Aprovar.
: Rejeitar.
: Abandonar.
: Reabrir.Comments.
NotaAbandoned: abandona a revisão atual. Após o abandono, o sistema permite o envio e a implantação direta do nó.
Reopen: reabre uma revisão abandonada para uma nova análise.
Após a conclusão da revisão, o solicitante pode visualizar os detalhes e gerencie tickets na página Code Review List > Reviewed by Me.
Comentários em nível de linha
Na página de detalhes, revisores e solicitantes podem deixar comentários em nível de linha na visualização de diferenças (diff) das alterações de código ou das alterações de configuração de agendamento para discutir linhas ou itens específicos.
-
Escopo:
As alterações de código e as alterações de configuração de agendamento são apresentadas em uma visualização de diff lado a lado, que aceita comentários em uma ou várias linhas em ambos os lados.
O sistema armazena separadamente os comentários sobre alterações de código e de configuração, o que facilita a localização e o rastreamento das discussões.
As alterações de configuração de qualidade são somente leitura e não possuem ponto de entrada para comentários em nível de linha.
-
Operações e status:
Se a revisão de código não for aprovada, você pode comentar e responder, ou então edite, exclua, resolva ou reabra um comentário.
Após a aprovação da revisão, os comentários tornam-se somente leitura. Você só poderá visualizar os comentários existentes, sem permissão para adicionar, responder, editar, excluir, resolver ou reabrir.
As operações disponíveis para comentários em nível de linha dependem da sua função no ticket (autor, revisor, solicitante, administrador do projeto ou outro membro) e do status atual da revisão.
Revisão inteligente com IA
O revisor pode usar IA para analisar inteligentemente as alterações atuais no código e obter rapidamente uma sugestão de conclusão, um resumo das alterações e uma lista de problemas. A IA fornece apenas sugestões; o revisor toma a decisão final sobre a aprovação.
-
Gere uma sugestão de revisão por IA.
Na seção de operações, clique no ícone de revisão inteligente ao lado de Comment. A IA analisa as alterações atuais no código e exibe o painel Generated Result ao concluir.
-
Visualize o resultado gerado.
O painel Generated Result contém:
Sugestão de conclusão da revisão: a IA sugere Recomendar aprovação ou Recomendar rejeição.
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 sistema preenche automaticamente a caixa de comentários e sincroniza a conclusão; envie a revisão após a confirmação.
Regenerate: reanalisa as alterações e gera uma nova sugestão.
Reject: descarta a sugestão da IA. O painel é recolhido e a revisão prossegue manualmente.
Solicitante da revisão: Visualizar os resultados da revisão
O solicitante pode visualizar os resultados e gerenciar tickets em Code Review List > Reviewed by Me > Created by Me.
-
Em seguida, acesse a página de revisão de código.
Clique no ícone
no painel de navegação à esquerda do Data Studio para acessar a página de revisão e 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 de código e execute operações nos tickets.
-
Na página da lista de revisão: o solicitante pode visualizar rapidamente os resultados e executar as seguintes operações: Abandoned, Reopen ou Share.
NotaApós o abandono da revisão, envie a versão atual do nó para uma nova revisão ou reabra o ticket antes de continuar a implantação.
Na página de detalhes: em Code Review List > Reviewed by Me, clique no ticket correspondente para acessar Code Review Details e decidir se deseja Reopen ou marcar como Abandoned.
-
Se a revisão não for aprovada, o sistema bloqueia o envio e a implantação do nó. Por favor, modifique o código com base nos comentários e inicie uma nova avaliação. O nó só será implantado após a aprovação da nova revisão.
Próxima etapa
Após a aprovação da revisão de código, prossiga com a implantação. Se a revisão não for aprovada, ajuste o código com base nos comentários e inicie uma nova avaliação.