O Mandato é onde você indica o que o CoRoid pode fazer sem precisar de uma pessoa. Ele tem seu próprio espaço na navegação, ao lado de Controle de Qualidade, e possui duas partes: Visão geral informa o que está configurado, e Configurações é onde você altera isso.
O que a Visão geral informa
A Visão geral responde a uma pergunta: o que o CoRoid faz sem pedir sua autorização?
Começa com uma frase, por exemplo: "O CoRoid inicia correções de segurança por conta própria e está aprendendo a mesclar em modo oculto. Todas as demais etapas aguardam sua intervenção." Se o CoRoid também corrige ou bloqueia pull requests sozinho, uma segunda linha indica isso. Abaixo dela estão as quatro etapas definidas pelo Mandato, na ordem em que o trabalho passa por elas:
| Etapa | O que significa |
|---|---|
| Iniciar trabalho | O CoRoid inicia uma tarefa que ninguém solicitou, sob um dos seus objetivos. |
| Mesclar | O CoRoid mescla um pull request |
| Implantar | O CoRoid implanta em um ambiente |
| Reverter | O CoRoid desfaz uma implantação com falha. |
Cada etapa indica uma dessas situações:
- Solicita sua intervenção. Nenhuma autorização cobre essa ação, então uma pessoa deve executá-la.
- Aprendizado em modo oculto. Uma autorização cobre essa ação, mas apenas registra o que teria sido feito. A etapa indica desde quando e o que foi feito até o momento.
- Executa a tarefa sozinho. Uma autorização ativa cobre essa ação, e a etapa indica para qual trabalho e como ele te informará.
- Interrompido pelo CoRoid. O CoRoid interrompeu a autorização da etapa por conta própria. Abra-a para ver o motivo.
- Apenas correções de segurança (Iniciar trabalho). O CoRoid inicia correções de segurança nas Configurações de Segurança, e uma pessoa cuida de todo o restante.
Uma etapa abre sua autorização nas Configurações, ou uma nova autorização para essa etapa.
Abaixo das etapas:
- Sempre depende da decisão de uma pessoa: os caminhos protegidos e a maior quantidade de pull requests que o CoRoid mantém abertos em um projeto. Uma alteração em um caminho protegido nunca é mesclada ou implantada pelo CoRoid, independentemente do que a autorização indique.
- Objetivos: aquilo para o qual o CoRoid trabalha, quanto pode gastar e o que acontece com esse trabalho.
- Projetos: Um projeto pausado ou que restringe uma autorização aparece em uma linha. O restante segue a organização.
Proprietários e administradores podem pausar a autonomia a partir do topo da Visão geral.
Configurá-lo
- Abra Mandato → Configurações e selecione Iniciar a partir de uma predefinição, ou Nova autorização para uma etapa.
- A autorização começa em modo oculto. Deixe-a rodar por um tempo no seu trabalho real.
- Abra a autorização e leia o que ela teria feito. Quando o registro te convencer, selecione Tornar ativa.
- Se quiser receber notificações no Slack ou Telegram, adicione um roteamento para O que o CoRoid faz em Configurações → Conexões → Rotas de notificação.
Você pode retornar uma autorização para modo oculto ou pausar a autonomia a qualquer momento.
Configurações
As Configurações mostram primeiro a organização e depois cada projeto. Cada linha indica o que está configurado; ao selecioná-la, seu editor é aberto em um painel lateral. Nada é editado diretamente na página.
| Grupo | Linhas |
|---|---|
| Autonomia | Pausar, com quaisquer retenções e suspensões; a Reserva de recuperação |
| Autorizações | Uma linha por autorização, com Iniciar a partir de uma predefinição e Nova autorização |
| Objetivos | Uma linha por objetivo, com Novo objetivo |
| Limites | Caminhos protegidos, Ações de entrega, Pull requests abertos, Agentes |
| Histórico | Toda alteração no Mandato e todas as decisões tomadas sob ele |
A página de um projeto tem sua própria opção de pausar, as autorizações que possui e seu histórico. Objetivos e limites são da organização.
Autorizações
Uma autorização é algo que o CoRoid pode fazer sem uma pessoa. Sua linha nomeia a ação, por exemplo "Mesclar trabalho solicitado por uma pessoa", e indica até onde vai:
Classificada como Baixa, em todos os projetos. No máximo 5 por dia. Primeiro avisa você e espera 10 minutos para uma interrupção.
Em seu painel, você edita parte por parte: a etapa, o trabalho ao qual se aplica, o risco das alterações cobertas, quais projetos, os limites, os caminhos que deve deixar de lado e como ele te informará.
Uma autorização que implanta também pode limitar as alterações em uma única implantação: quantos pull requests mesclados um release pode ter para que o CoRoid o implante. Um release maior fica a cargo de uma pessoa para implantar, para que um lote que falhe inteiramente nunca chegue à produção sem intervenção humana.
Uma concessão cobre uma das quatro etapas, ou uma das duas ações que o CoRoid realiza em pull requests:
- Corrigir pull requests. Quando as verificações falham em um pull request do próprio trabalho do CoRoid, ele inicia um ciclo para corrigi-los. Sem uma concessão para esse trabalho, ele deixa a falha para a pessoa responsável pela Revisão. Quando você escolhe 'Corrigir verificações com falha' manualmente, não é necessária nenhuma concessão.
- Bloquear pull requests. Quando a Revisão do CoRoid identifica um problema que precisa ser corrigido, ela solicita alterações, fazendo com que o pull request aguarde por uma pessoa. Sem uma concessão para o projeto, a revisão resulta apenas em um comentário e a verificação não falha. Uma concessão de bloqueio abrange todos os pull request dentro de seus projetos, independentemente de quem os abriu ou do nível de risco, exceto nos casos em que envolvem caminhos excluídos da concessão.
Ambas eram ações que o CoRoid já realizava antes de se tornarem concessões. Cada organização as tem como concessões ativas; portanto, nada muda quando se tornam decisões: restrinja uma a alguns projetos ou revogue-a, e o CoRoid interromperá o processo. Uma pausa também os paralisa.
O painel de uma concessão exibe apenas o que sua etapa requer. O início do trabalho, a correção e o rollback são decididos antes de qualquer alteração ser feita, portanto não possuem nível de risco ou caminhos excluídos. Uma concessão de bloqueio não tem 'de quem é o trabalho': ela abrange todo o trabalho do pull request.
O CoRoid não pergunta mais sobre a implementação do trabalho: o início do trabalho é a decisão tomada naquele momento. Uma concessão para implementação indica isso e pode ser revogada.
Uma concessão começa em modo sombra
Uma nova concessão não permite nada. Em modo sombra o CoRoid registra o que a concessão permitiria, para que você possa consultar essas informações antes de confiar nela. Tornar ativa a coloca em vigor.
Uma edição que permite que uma concessão faça mais a envia de volta ao modo sombra. Uma edição que apenas a restringe não faz isso.
O que ela permitiria fazer
Abra uma concessão para ver:
- com que frequência o CoRoid a solicitou e o que permitiria em modo sombra;
- para uma concessão que Mesclar, nos últimos 30 dias: quantos pull requests desse tipo foram Mesclados, quantos a concessão teria Mesclado, por que os demais não foram Mesclados e cada um que teria sido Mesclado mas foi revertido, corrigido ou teve acompanhamento posterior;
- o que a concessão precisa antes de poder se tornar ativa.
Uma concessão para alterações classificadas como Baixo não requer nada além disso: as regras definem essa classificação. Uma concessão para alterações classificadas como Médio depende de um modelo, portanto só se torna ativa com base em registros: pelo menos 30 pull requests avaliados dessa categoria sem aprovação indevida e pelo menos 10 alterações problemáticas identificadas, todas bloqueadas. Até lá, a concessão indica o que ainda falta.
Começar a partir de um preset
Começar a partir de um preset preenche o Mandato com um conjunto de concessões, todas em modo sombra:
| Preset | O que ele adiciona |
|---|---|
| Reparar | Iniciar o trabalho conforme seus objetivos |
| Mesclar | Reparar e Mesclar esse trabalho quando for classificado como Baixo |
| Enviar | Mesclar e implantar em um ambiente que você definir |
| Loop fechado | Enviar e reverter esse ambiente quando uma implantação falhar |
| Manter as dependências atualizadas | Mesclar atualizações de dependências classificadas como Baixo |
Uma predefinição nunca ativa um mandato nem acrescenta nada ao que você já tem.
Um projeto pode restringir uma concessão
As concessões da organização são o padrão para todos os projetos. Na página de um projeto, selecione uma concessão para desativá-la para esse projeto, reduzir seu nível, limitar seus escopos ou adicionar caminhos excluídos. Um projeto não pode ter mais permissões do que a organização concedeu.
Quando o próprio CoRoid interrompe uma concessão
- Retida. O revisor ou o avaliador de risco do CoRoid mudou, e a concessão ainda não foi avaliada na nova versão. Ela se tornará ativa novamente por conta própria quando isso ocorrer.
- Suspensa pelo seu mecanismo de interrupção. Os Mesclados permitidos pela concessão foram revertidos, corrigidos ou tiveram acompanhamento posterior com mais frequência do que os Mesclados feitos pelas pessoas nos mesmos projetos. Uma única falha não causa isso. A concessão exibe ambos os números. Uma pessoa pode levantar a suspensão e explicar o motivo.
O que uma concessão pode Mesclar
Uma concessão que Mesclar indica o trabalho que abrange. Ela ainda cobre apenas alterações classificadas no mesmo nível ou inferior.
| Trabalho | O que ela abrange |
|---|---|
| Trabalho solicitado pelas pessoas | Um pull request aberto pelo CoRoid para uma tarefa solicitada por uma pessoa |
| Trabalho sob um objetivo | Um pull request aberto pelo CoRoid para trabalho iniciado sob um dos seus objetivos |
| Atualizações de dependências | Um pull request gerado pelo Dependabot ou Renovate (no GitLab, um merge request aberto por um bot com token de acesso do projeto ou grupo a partir de uma renovate/ ramificação) que atualiza pacotes npm, cada um para uma versão patch ou minor da mesma linha de versões, publicada há pelo menos 7 dias, sem novo script de instalação, com um arquivo de bloqueio que corresponde a package.json, e sem nenhum aviso de segurança aberto. Essa atualização é classificada como Baixa após 7 dias. |
| Pessoas confiáveis | Um pull request feito por um membro cujo nome está no mandato, quando todos os commits desde sua base foram criados e confirmados pela conta GitHub vinculada desse membro, e o GitHub verificou sua assinatura. No GitLab, uma solicitação de merge aberta pela conta GitLab vinculada ao membro, quando o GitLab verifica a assinatura de cada commit e o e-mail do autor e do committer corresponde ao que o membro confirmou no GitLab. Um commit feito no editor web ou enviado por outra pessoa fica sob responsabilidade de uma pessoa. |
Como um mandato é mesclado
O plano de merge na Factory coloca um pull request coberto pelo mandato sob CoRoid pode mesclar agora, e o trem de merge o mescla. No momento em que ele é mesclado, o CoRoid consulta novamente o Mandato; assim, uma pausa, uma retenção, um limite esgotado ou um novo commit desde a criação do plano podem interromper o processo.
O commit de merge nomeia o mandato e sua versão. O merge conta como parte do mandato para a pessoa designada como responsável, tanto no Histórico quanto nos limites do mandato.
Em segundo plano, o plano de merge indica que o mandato mesclará o pull request, e uma pessoa decide.
Anunciar e parar
Um mandato define como ele informa você sobre uma mesclagem:
- Primeiro, e aguarda um comando de Parar. Quando o trem de merge pega a solicitação de pull request, a pessoa responsável pelo mandato e quem solicitou o trabalho recebem uma notificação. O CoRoid mescla quando o prazo termina, por exemplo após 10 minutos, a menos que alguém pressione Parar na notificação ou no plano de merge, ou, com uma conta vinculada, em sua postagem no Slack ou Telegram. Um pull request parado aguarda a decisão de uma pessoa.
- Depois de cada um. Você é informado quando a mesclagem ocorre.
Vinculando suas contas
Um mandato para pessoas confiáveis e as Aprovações do CoRoid precisam saber qual conta GitHub ou GitLab é sua. O recurso Parar no Slack ou Telegram precisa saber qual conta Slack ou Telegram é sua. Em Perfil → Contas vinculadas, vincule cada uma; a plataforma confirma isso. O CoRoid armazena o ID e o nome da conta, nunca um token. Para o GitLab, também mantém um resumo de cada e-mail que você confirmou lá (não os e-mails próprios), que é como ele sabe que um commit é seu; vincule novamente após adicionar um e-mail. Desvincular remove tudo. Quando sua organização conecta um GitLab gerenciado localmente, esse GitLab terá sua própria linha após ser configurado por um proprietário ou administrador (Vinculando as contas das pessoas no seu GitLab).
Objetivos
Um objetivo define para onde o CoRoid trabalha autonomamente, em quais projetos e quanto pode gastar. Versões anteriores chamavam objetivos de mandatos; Objetivos descrevem-nos detalhadamente.
Um objetivo dá ao CoRoid uma meta e um orçamento. As solicitações provenientes de seus sistemas que um objetivo assume começam conforme descrito em Quando o trabalho começa. O CoRoid gerencia arquivos sob um objetivo, como um acompanhamento quando uma alteração não atingiu seu resultado; isso requer um mandato ativo para Iniciar trabalho; até então, aguarda que uma pessoa o inicie. As correções de Segurança são a exceção: elas começam sob as configurações próprias da Segurança.
Limites
O que o CoRoid nunca pode fazer autonomamente, independentemente do que o mandato estabeleça:
- Caminhos protegidos. Uma pessoa decide cada alteração neles. O CoRoid protege login e acesso, cobrança e pagamentos, segredos e credenciais, criptografia, migrações de banco de dados, arquivos de bloqueio, pipelines de CI, containers e infraestrutura; você também pode adicionar caminhos próprios. Apenas um proprietário pode remover um deles, com um motivo registrado.
- Ações de entrega. O máximo que um mandato pode fazer aqui: mesclar, implantar e reverter, cada uma permitida, solicitada ou negada.
- Solicitações de pull request abertas. Quantas solicitações de pull request próprias o CoRoid mantém abertas em um projeto. Ao atingir o limite, o trabalho iniciado autonomamente aguarda; a solicitação de uma pessoa sempre é atendida.
- Agentes. Até que ponto um agente pode atuar e se automações e agendamentos podem criar tarefas. Se a Revisão do CoRoid pode bloquear um pull request depende de um mandato.
Histórico
Toda alteração no Mandato e toda decisão tomada sob ele, do mais recente para o mais antigo: quem publicou ou alterou um mandato, o que o CoRoid foi autorizado ou proibido de fazer e por quê, e quais respostas as pessoas deram quando o CoRoid perguntou.
Quando o CoRoid pede sua opinião
Algumas ações exigem primeiramente a resposta de uma pessoa. Cada uma aparece como uma linha em Precisa de você na Factory: o que o CoRoid pede para fazer, onde e por quê. Aprovar uma vez permite que ele realize essa ação uma única vez. Recusar impede que ele a realize. Veja A Factory.
Quem pode alterá-lo
Proprietários e administradores alteram o Mandato. Os Membros podem ler todo o conteúdo dele. Os agentes e contas de serviço do próprio CoRoid não têm permissão para modificá-lo de forma alguma.
Toda decisão tomada sob um mandato também é registrada no fluxo de auditoria da sua organização, juntamente com o CoRoid correspondente, o mandato e sua versão.