Documentación

El Mandato

Una página que muestra lo que puede hacer CoRoid sin intervención humana, lo que ya realizó y permite detenerlo.

El Mandato es donde indicas qué puede hacer CoRoid sin necesidad de pedirlo a una persona. Tiene su propia ubicación en la navegación, junto a Control de Calidad, y consta de dos partes: Resumen te indica qué está configurado, y Configuración es donde lo modificas.

Qué te muestra el Resumen

El Resumen responde a una pregunta: ¿qué hace CoRoid sin preguntarte?

Comienza con una frase, por ejemplo: "CoRoid inicia correcciones de seguridad por sí mismo y está aprendiendo a fusionar en modo oculto. Todos los demás pasos esperan tu intervención." Si CoRoid también corrige o bloquea solicitudes de incorporación de cambios por sí solo, una segunda línea lo indicará. Debajo se muestran los cuatro pasos que determina el Mandato, en el orden en que se procesa el trabajo:

PasoQué significa
Iniciar trabajoCoRoid inicia una tarea que nadie solicitó, bajo uno de tus objetivos.
FusionarCoRoid fusiona un pull request
DesplegarCoRoid despliega en un entorno
RevertirCoRoid deshace un despliegue fallido

Cada paso indica una de estas opciones:

  • Te lo pide. No hay autorización para ello, así que lo hace una persona.
  • Aprendizaje en modo oculto. Hay autorización para ello, pero solo registra lo que habría hecho. El paso indica desde cuándo y qué habría hecho hasta ahora.
  • Lo hace por sí mismo. Hay una autorización activa para ello, y el paso indica para qué trabajo y cómo te informa.
  • Detenido por CoRoid. CoRoid detuvo la autorización del paso por sí mismo. Ábrela para ver por qué.
  • Solo correcciones de seguridad (Iniciar trabajo). CoRoid inicia correcciones de seguridad según la configuración de Seguridad, y una persona gestiona todo lo demás.

Un paso abre su autorización en Configuración, o una nueva autorización para ese paso.

Debajo de los pasos:

  • Siempre depende de la decisión de una persona: las rutas protegidas y el mayor número de solicitudes de incorporación de cambios que CoRoid mantiene abiertas en un proyecto. Un cambio en una ruta protegida nunca será fusionado ni desplegado por CoRoid, independientemente de lo que diga la autorización.
  • Objetivos: aquello hacia lo que trabaja CoRoid, lo que puede gastar y qué ocurre con ese trabajo.
  • Proyectos: Un proyecto en pausa o que limite una autorización tendrá una fila. El resto sigue las normas de la organización.

Los propietarios y administradores pueden pausar la autonomía desde la parte superior del Resumen.

Configurarlo

  1. Abre Mandato → Configuración y selecciona Empezar desde un preset, o Nueva autorización para un paso.
  2. La autorización comienza en modo oculto. Déjala ejecutarse durante un tiempo en tu trabajo real.
  3. Abre la autorización y lee lo que habría hecho. Cuando el registro te convenza, selecciona Hacer activa.
  4. Si quieres recibir notificaciones en Slack o Telegram, añade una ruta para Qué hace CoRoid en Configuración → Conexiones → Rutas de notificación.

Puedes devolver una autorización a modo oculto o pausar la autonomía en cualquier momento.

Configuración

Configuración muestra primero la organización y luego cada proyecto. Cada fila indica qué está configurado; al seleccionarla se abre su editor en un panel lateral. Nada se edita directamente en la página.

GrupoFilas
AutonomíaPausar, con cualquier retención y suspensión; la Reserva de recuperación
AutorizacionesUna fila por autorización, con Empezar desde un preset y Nueva autorización
ObjetivosUna fila por objetivo, con Nuevo objetivo
LímitesRutas protegidas, Acciones de entrega, Solicitudes de incorporación de cambios abiertas, Agentes
HistorialCada cambio en el Mandato y cada decisión tomada bajo él

La página de un proyecto tiene su propia pausa, las autorizaciones que posee y su historial. Los objetivos y límites son de la organización.

Autorizaciones

Una autorización es algo que CoRoid puede hacer sin intervención humana. Su fila le da nombre, por ejemplo "Fusionar trabajo solicitado por una persona", y indica hasta dónde llega:

Clasificada como Baja, en todos los proyectos. Máximo 5 al día. Te avisa primero y espera 10 minutos para una orden de Detener.

En su panel puedes editarla por partes: el paso, el trabajo al que se aplica, el nivel de riesgo de los cambios que cubre, los proyectos, los límites, las rutas que excluye y cómo te informa.

Una autorización que despliega también puede limitar los cambios en un único despliegue: cuántas solicitudes de incorporación de cambios fusionadas puede incluir una versión para que CoRoid la despliegue. Una versión más grande se deja para que la despliegue una persona, de modo que un lote que falle completamente nunca llegue a producción sin supervisión.

Una concesión cubre uno de los cuatro pasos, o una de las dos acciones que CoRoid realiza en las solicitudes de fusión:

  • Corregir solicitudes de fusión. Cuando las comprobaciones fallan en un pull request del propio trabajo de CoRoid, este inicia un ciclo para corregirlos. Sin una concesión para ese trabajo, deja el error a cargo de la persona encargada de la revisión. Si tú mismo seleccionas la opción "Corregir comprobaciones fallidas", no se necesita concesión.
  • Bloquear solicitudes de fusión. Cuando la herramienta de Revisión de CoRoid detecta un problema que debe corregirse, solicita cambios, por lo que el pull request espera la intervención de una persona. Sin una concesión para el proyecto, la revisión se limita a un comentario y la comprobación no falla. Una concesión de bloqueo cubre todos los pull request de sus proyectos, independientemente de quién los haya abierto o del nivel de riesgo que presenten, salvo cuando afecten a rutas excluidas por la concesión.

Ambas acciones ya las realizaba CoRoid antes de convertirse en concesiones. Cada organización las tiene activas como concesiones, por lo que nada cambia al pasar a ser decisiones: si las restringes a algunos proyectos o las revocas, CoRoid dejará de ejecutarlas. Una pausa también detiene su ejecución.

El panel de una concesión solo muestra lo que solicita su paso correspondiente. La iniciación del trabajo, la corrección y la reversión se deciden antes de cualquier modificación en la calificación, por lo que no tienen nivel de riesgo ni rutas excluidas. Una concesión de bloqueo no tiene asociado "el trabajo de quién": cubre todo el trabajo de pull request.

CoRoid ya no pregunta sobre la ejecución del trabajo: iniciar el trabajo es la decisión que se toma en ese momento. Una concesión para la ejecución lo indica así y puede ser revocada.

Una concesión comienza en modo sombra

Una nueva concesión no permite nada. En modo sombra CoRoid registra lo que la concesión habría permitido, para que puedas consultarlo antes de confiar en ella. Activar la pone en vigor.

Una edición que amplía las capacidades de una concesión devuelve la concesión activa a modo sombra. Una edición que solo la restringe no lo hace.

Lo que habría hecho

Abre una concesión para ver:

  • con qué frecuencia CoRoid la solicitó y lo que habría permitido en modo sombra;
  • para una concesión que fusiona, los últimos 30 días: cuántas solicitudes de fusión de ese tipo se fusionaron, cuántas habría fusionado la concesión, por qué no se fusionaron las demás y cada una que habría fusionado y que luego se revirtió, corrigió o siguió tratándose;
  • qué requisitos debe cumplir la concesión para volverse activa.

Una concesión para cambios clasificados como Bajo no requiere nada más: las reglas asignan esa calificación. Un mandato para cambios calificados como Medio depende de un modelo, así que solo se activa cuando hay un registro con al menos 30 pull requests evaluadas de su categoría sin ninguna aprobación errónea y al menos 10 cambios defectuosos sembrados, todos bloqueados. Hasta entonces, el mandato indica qué falta.

Iniciar desde un preset

Iniciar desde un preset rellena el Mandato con un conjunto de concesiones, todas en modo sombra:

PresetQué añade
RepararIniciar trabajo según tus objetivos
FusionarReparar y fusionar ese trabajo cuando se clasifique como Bajo
DesplegarFusionar y desplegar en un entorno que tú indiques
Ciclo cerradoDesplegar y revertir ese entorno cuando un despliegue falle
Mantener las dependencias actualizadasFusionar actualizaciones de dependencias clasificadas como Bajo

Un preset nunca activa una concesión y no añade nada que ya tengas.

Un proyecto puede limitar un mandato

Las concesiones de la organización son el valor predeterminado para todos los proyectos. En la página de un proyecto, selecciona una concesión para desactivarla para ese proyecto, reducir su nivel, acortar sus límites o añadir rutas excluidas. Un proyecto no puede otorgarse más derechos de los que la organización le concede.

Cuando CoRoid detiene una concesión por sí mismo

  • En espera. El revisor o el evaluador de riesgos de CoRoid ha cambiado y la concesión aún no se ha medido en la nueva versión. Se volverá activa por sí sola cuando eso ocurra.
  • Suspendida por su mecanismo de interrupción. Las fusiones que la concesión permitió se revirtieron, corrigieron o siguieron tratándose con más frecuencia que las fusiones realizadas por las personas en los mismos proyectos. Un único fallo no causa esto. La concesión muestra ambos recuentos. Una persona levanta la suspensión y explica el motivo.

Qué puede fusionar una concesión

Una concesión que fusiona indica el trabajo que cubre. Sigue cubriendo solo los cambios clasificados en su nivel o inferior.

TrabajoQué cubre
Trabajo solicitado por personasUn pull request de CoRoid abierto para una tarea solicitada por una persona
Trabajo bajo un objetivoUn pull request de CoRoid abierto para trabajo iniciado bajo uno de tus objetivos
Actualizaciones de dependenciasUn pull request generado por Dependabot o Renovate (en GitLab, una solicitud de fusión abierta por el bot del token de acceso del proyecto o grupo desde una renovate/ rama) que actualiza paquetes npm, cada uno a una versión patch o minor de la misma línea de versiones, publicada hace al menos 7 días, sin nuevos scripts de instalación y con un archivo de bloqueo que coincide con package.jsony sin ningún aviso de seguridad abierto. Una vez transcurridos 7 días, dicha actualización se clasifica como de bajo riesgo.
Personas de confianzaUn pull request creado por un miembro cuyo nombre figure en la concesión, siempre que cada confirmación desde su base haya sido redactada y enviada mediante la cuenta GitHub vinculada a ese miembro y GitHub haya verificado su firma. En GitLab, una solicitud de fusión abierta por la cuenta GitLab vinculada al miembro, cuando GitLab haya verificado la firma de cada confirmación y el correo electrónico del autor y del responsable de cada confirmación coincida con los datos confirmados por el miembro en GitLab. Una confirmación realizada en el editor web o enviada por otra persona queda pendiente de revisión humana.

Cómo se fusiona una concesión

El plan de fusión en la Fábrica coloca un pull request cubierto por la concesión bajo CoRoid puede fusionarlo ahoray el tren de fusión lo incorpora. En el momento de la fusión, CoRoid vuelve a consultar el Mandato; por tanto, una pausa, retención, límite alcanzado o una nueva confirmación tras la creación del plan pueden detener el proceso.

La confirmación de fusión lleva el nombre de la concesión y su versión. Esta fusión se registra como parte de la concesión, para la persona designada como responsable en el Historial y en los límites de la concesión.

En segundo plano, el plan de fusión indica que la concesión fusionará el pull request, y una persona toma la decisión final.

Anunciar y detener

Una concesión define cómo notifica sobre una fusión:

  • Primero, y espera a una orden de Detener. Cuando el tren de fusión procese la solicitud de extracción, la persona responsable de la concesión y quien solicitó la tarea recibirán una notificación. CoRoid la fusionará al finalizar el plazo, por ejemplo después de 10 minutos, a menos que alguien pulse Detener en la notificación o en el plan de fusión, o, si hay una cuenta vinculada, en su mensaje en Slack o Telegram. Un pull request detenido espera la intervención de una persona.
  • Después de cada uno. Se le informará cuando se haya fusionado.

Vincular sus cuentas

Una concesión para personas de confianza y las Aprobaciones de CoRoid necesitan saber qué cuenta de GitHub o GitLab es la suya. Las notificaciones de Stop en Slack o Telegram también requieren conocer su cuenta de Slack o Telegram. En Perfil → Cuentas vinculadas, vincule cada una; la plataforma lo confirmará. CoRoid guarda el ID y el nombre de la cuenta, nunca un token. Para GitLab, también conserva un resumen de cada correo electrónico que haya confirmado allí (no los correos en sí), lo que le permite identificar si una confirmación es suya; vincule nuevamente tras agregar un correo electrónico. Desvincular la elimina por completo. Si su organización conecta un GitLab gestionado de forma independiente, ese GitLab tendrá su propia entrada una vez que un propietario o administrador lo configure (Vincular las cuentas de las personas en su GitLab).

Objetivos

Un objetivo define hacia qué trabaja CoRoid de forma autónoma, en qué proyectos y cuánto puede invertir. En versiones anteriores, los objetivos se denominaban mandatos; Objetivos los describe en detalle.

Un objetivo otorga a CoRoid una meta y un presupuesto. Las solicitudes provenientes de sus sistemas que un objetivo gestiona comienzan según lo descrito en Cuando comienza el trabajo. El trabajo de CoRoid se gestiona por sí mismo bajo un objetivo; por ejemplo, un seguimiento cuando un cambio no logró el resultado esperado requiere una concesión activa para Iniciar trabajo; hasta entonces espera a que una persona lo inicie. Las correcciones de Seguridad son la excepción: se inician según la configuración propia de Seguridad.

Límites

Lo que CoRoid nunca debe hacer por sí solo, independientemente de lo que indique una concesión:

  • Rutas protegidas. Una persona decide cada cambio en estas rutas. CoRoid protege el inicio de sesión y el acceso, la facturación y los pagos, los secretos y credenciales, la criptografía, las migraciones de bases de datos, los archivos de bloqueo, las canalizaciones de CI, los contenedores y la infraestructura; además, puede agregar sus propias rutas. Solo un propietario puede eliminar alguna de las rutas definidas por CoRoid, siempre con una razón registrada.
  • Acciones de entrega. Lo máximo que una concesión puede hacer aquí: fusionar, desplegar y revertir; cada una de estas acciones puede ser permitida, solicitada o denegada.
  • Solicitudes de extracción abiertas. Cuántas solicitudes de extracción propias mantiene CoRoid abiertas en un proyecto. Al alcanzar el límite, el trabajo que inicia por sí mismo espera; las solicitudes de una persona siempre se inician.
  • Agentes. Hasta qué punto puede actuar un agente y si las automatizaciones y programaciones pueden crear tareas. Si CoRoid Review puede bloquear a pull request depende de la concesión.

Historial

Cada cambio en el Mandato y cada decisión tomada bajo él, del más reciente al más antiguo: quién publicó o modificó una concesión, qué se permitió o prohibió a CoRoid y por qué, y qué respondieron las personas cuando CoRoid preguntó.

Cuando CoRoid le pide algo

Algunas acciones requieren primero la respuesta de una persona. Cada una aparece como una fila bajo Requiere tu atención en la Fábrica: qué debe hacer CoRoid, dónde y por qué. Aprobar una vez permite que realice esa acción una sola vez. Rechazar impide que la realice. Consulte La Fábrica.

Quién puede modificarlo

Los propietarios y administradores modifican el mandato. Los miembros pueden leerlo en su totalidad. Los agentes y cuentas de servicio de CoRoid no pueden alterarlo en absoluto.

Toda decisión tomada bajo una concesión también se registra en el flujo de auditoría de tu organización, junto con la concesión y su versión, como ocurre con CoRoid.