Documentation

Le Mandat

Une page qui décrit ce que CoRoid peut faire sans intervention humaine, montre ce qu'il a déjà accompli et permet de l'arrêter.

Le Mandat est l'endroit où vous indiquez ce que CoRoid peut faire sans demander à une personne. Il possède sa propre place dans la navigation, à côté du Contrôle qualité, et se compose de deux parties : Aperçu vous indique ce qui est configuré, et Paramètres est l'endroit où vous le modifiez.

Ce que l'Aperçu vous montre

L'Aperçu répond à une seule question : que fait CoRoid sans vous consulter ?

Tout commence par une phrase, par exemple : "CoRoid lance lui-même les correctifs de sécurité et apprend à fusionner en mode silencieux. Toutes les autres étapes attendent votre intervention." Si CoRoid corrige ou bloque également des demandes de fusion tout seul, une deuxième ligne l'indique. En dessous figurent les quatre étapes définies par le Mandat, dans l'ordre où le travail les traverse :

ÉtapeSignification
Démarrer le travailCoRoid commence un travail non sollicité, dans le cadre d'un de vos objectifs.
FusionnerCoRoid fusionne un pull request
DéployerCoRoid déploie dans un environnement.
Annuler le déploiementCoRoid annule un déploiement ayant échoué.

Chaque étape indique l'une de ces options :

  • Demande votre avis. Aucune autorisation ne le couvre, donc une personne s'en charge.
  • Apprentissage en mode silencieux. Une autorisation le couvre, mais ne consigne que ce qu'il aurait fait. L'étape précise depuis quand et ce qu'il aurait accompli jusqu'à présent.
  • Le fait lui-même. Une autorisation active le couvre, et l'étape précise pour quel travail et comment il vous informe.
  • Arrêté par CoRoid. CoRoid a lui-même interrompu l'autorisation de l'étape. Ouvrez-la pour connaître la raison.
  • Correctifs de sécurité uniquement (Démarrer le travail). CoRoid lance les correctifs de sécurité selon les paramètres propres à la Sécurité, et une personne s'occupe de tout le reste.

Une étape ouvre son autorisation dans Paramètres, ou une nouvelle autorisation pour cette étape.

En dessous des étapes :

  • Toujours une décision humaine : les chemins protégés et le nombre maximal de demandes de fusion que CoRoid garde ouvertes dans un projet. Une modification d'un chemin protégé n'est jamais fusionnée ou déployée par CoRoid, quelle que soit l'autorisation en place.
  • Objectifs : ce vers quoi CoRoid travaille, ce qu'il peut dépenser, et ce qu'il advient de ce travail.
  • Projets : Un projet en pause ou dont l'autorisation est restreinte dispose d'une ligne. Les autres suivent l'organisation.

Les propriétaires et administrateurs peuvent suspendre l'autonomie depuis le haut de l'Aperçu.

Le configurer

  1. Ouvrez Mandat → Paramètres et sélectionnez Commencer à partir d'un preset, ou Nouvelle autorisation pour une étape.
  2. L'autorisation démarre en mode silencieux. Laissez-la fonctionner un certain temps sur votre travail réel.
  3. Ouvrez l'autorisation et lisez ce qu'elle aurait fait. Si l'historique vous convainc, choisissez Rendre active.
  4. Si vous souhaitez en être informé sur Slack ou Telegram, ajoutez une route pour Ce que CoRoid fait sous Paramètres → Connexions → Itinéraires de notification.

Vous pouvez ramener une autorisation en mode silencieux ou suspendre l'autonomie à tout moment.

Paramètres

Paramètres présente d'abord l'organisation, puis chaque projet. Chaque ligne indique ce qui est configuré ; la sélection l'ouvre dans un panneau latéral. Rien n'est modifié directement sur la page.

GroupeLignes
AutonomieSuspendre, avec toutes les retenues et suspensions ; la Réserve de récupération
AutorisationsUne ligne par autorisation, avec Commencer à partir d'un preset et Nouvelle autorisation
ObjectifsUne ligne par objectif, avec Nouvel objectif
LimitesChemins protégés, Actions de livraison, Demandes de fusion ouvertes, Agents
HistoriqueChaque modification du Mandat et chaque décision prise dans son cadre

La page d'un projet présente sa propre suspension, ses autorisations et son historique. Les objectifs et limites sont propres à l'organisation.

Autorisations

Une autorisation est une action que CoRoid peut effectuer sans intervention humaine. Sa ligne la nomme, par exemple « Fusionner le travail demandé par une personne », et précise jusqu'où elle va :

Classée en niveau faible, dans tous les projets. Au maximum 5 par jour. Elle vous informe d'abord et attend 10 minutes avant un arrêt.

Dans son panneau, vous la modifiez par partie : l'étape, le travail auquel elle s'applique, le niveau de risque des modifications couvertes, les projets concernés, les limites, les chemins qu'elle ignore, et la manière dont elle vous informe.

Une autorisation de déploiement peut également limiter les modifications dans un déploiement : le nombre de demandes de fusion fusionnées qu'une version peut contenir pour que CoRoid la déploie. Une version plus importante est confiée à une personne pour le déploiement, afin qu'un lot échouant entièrement n'atteigne jamais la production sans intervention humaine.

Une autorisation couvre l'une des quatre étapes, ou l'une des deux actions que CoRoid effectue sur les demandes de fusion :

  • Corriger les demandes de fusion. Lorsque les vérifications échouent sur un pull request issu du travail de CoRoid, ce dernier lance une série de corrections. Sans autorisation pour ce travail, il laisse l'échec à la personne en charge de la révision. Si vous choisissez vous-même l'option « Corriger les vérifications ayant échoué », aucune autorisation n'est nécessaire.
  • Bloquer les demandes de fusion. Lorsque la fonctionnalité CoRoid Révision détecte un problème à corriger, elle demande des modifications, ce qui fait attendre le pull request la validation d'une personne. Sans autorisation pour le projet, la révision se limite à un commentaire et la vérification n'indique pas d'échec. Une autorisation de blocage couvre tous les pull request du projet, quel que soit leur créateur ou leur niveau de risque, sauf s'ils concernent des chemins exclus par l'autorisation.

Ces deux actions étaient déjà réalisées par CoRoid avant qu'elles ne deviennent des autorisations. Chaque organisation les utilise comme autorisations actives ; rien ne change lorsqu'elles deviennent des décisions : restreignez-en l'application à certains projets ou révoquez-les, et CoRoid cessera d'agir. Une pause a le même effet.

Le panneau d'une autorisation ne propose que les options requises par son étape. Le lancement du travail, la correction et l'annulation sont décidés avant toute modification de la note ; ils ne comportent donc ni niveau de risque ni chemins exclus. Une autorisation de blocage ne concerne pas un « travail spécifique » : elle couvre l'ensemble des actions de pull request.

CoRoid ne demande plus d'approbation pour lancer le travail : le lancement est une décision prise sur le moment. Une autorisation pour l'exécution du travail le précise, et peut être révoquée.

Une autorisation démarre en mode « ombre »

Une nouvelle autorisation n'autorise rien. En mode ombre CoRoid enregistre ce que l'autorisation aurait permis, afin que vous puissiez le consulter avant de vous y fier. Activer la rend effective.

Une modification permettant à une autorisation d'étendre ses droits renvoie l'autorisation active en mode « ombre ». Une modification limitant ses droits n'a pas cet effet.

Ce qu'elle aurait pu faire

Ouvrir une autorisation pour voir :

  • la fréquence à laquelle CoRoid l'a sollicitée, et ce qu'elle aurait permis en mode « ombre » ;
  • pour une autorisation de fusion, les 30 derniers jours : le nombre de demandes de fusion de ce type ayant été fusionnées, le nombre que l'autorisation aurait fusionné, les raisons de l'échec pour les autres, ainsi que chaque demande fusionée qui a ensuite été annulée, corrigée ou suivie ;
  • ce dont l'autorisation a besoin avant de pouvoir devenir active.

Une autorisation pour les modifications notées Faible n'exige rien de plus : les règles attribuent cette note. Une autorisation pour les modifications notées Moyen dépend d'un modèle ; elle ne devient active qu'après avoir collecté des données : au moins 30 demandes de fusion jugées de cette catégorie sans fausse approbation, et au moins 10 modifications incorrectes ayant toutes été bloquées. Jusqu'à ce stade, l'autorisation indique ce qui manque encore.

Démarrer à partir d'un preset

Démarrer à partir d'un preset remplit le Mandat avec un ensemble d'autorisations, toutes en mode « ombre » :

PresetCe qu'il ajoute
RéparerLancer le travail selon vos objectifs
FusionnerRéparer, puis fusionner le travail noté « Faible »
DéployerFusionner, puis déployer dans l'environnement que vous spécifiez
Boucle ferméeDéployer, puis revenir à l'environnement précédent en cas d'échec de déploiement
Garder les dépendances à jourFusionner les mises à jour de dépendances notées « Faible »

Un préréglage n’active jamais un mandat et n’ajoute rien à ce dont vous disposez déjà.

Un projet peut restreindre une autorisation

Les autorisations de l'organisation sont appliquées par défaut à chaque projet. Sur la page du projet, sélectionnez une autorisation pour la désactiver pour ce projet, réduire son niveau, limiter ses paramètres ou ajouter des chemins exclus. Un projet ne peut pas obtenir plus de droits que ceux accordés par l'organisation.

Lorsque CoRoid suspend lui-même une autorisation

  • En attente. Le réviseur ou l'outil d'évaluation des risques de CoRoid a changé, et l'autorisation n'a pas encore été évaluée sur la nouvelle version. Elle redeviendra active d'elle-même dès que ce sera le cas.
  • Suspendue par son mécanisme de blocage. Les demandes de fusion autorisées par l'autorisation ont été annulées, corrigées ou suivies plus souvent que les demandes créées par les personnes dans les mêmes projets. Un seul échec ne suffit pas à déclencher cette situation. L'autorisation affiche ces deux compteurs. Une personne peut lever la suspension et en expliquer la raison.

Ce qu'une autorisation peut fusionner

Une autorisation de fusion précise le travail qu'elle couvre. Elle ne s'applique toutefois qu'aux modifications notées à son niveau ou inférieur.

TravailCe qu'elle couvre
Travail demandé par les utilisateursUn pull request ouvert par CoRoid pour une tâche demandée par une personne
Travail mené dans le cadre d'un objectifUn pull request ouvert par CoRoid pour du travail initié dans le cadre de l'un de vos objectifs
Mises à jour de dépendancesUn pull request généré par Dependabot ou Renovate (sur GitLab, une demande de fusion ouverte par le bot du jeton d'accès du projet ou du groupe depuis une renovate/ branche) qui met à jour les packages npm, chacun vers une version patch ou mineure de la même ligne de version, publiée depuis au moins 7 jours, sans nouveau script d’installation, avec un fichier de verrouillage correspondant à package.json, et aucun avis de sécurité ouvert. Une telle mise à jour est classée en niveau Faible après 7 jours.
Personnes de confianceUn pull request par un membre dont le nom figure dans l'autorisation, lorsque chaque commit depuis sa base a été rédigé et validé par le compte GitHub associé à ce membre et que GitHub a vérifié sa signature. Sur GitLab, une demande de fusion initiée par le compte GitLab associé au membre, lorsque GitLab a vérifié la signature de chaque commit et que l'adresse e-mail de l'auteur et du validateur de chaque commit correspond à celle confirmée par le membre sur GitLab. Un commit effectué dans l'éditeur web ou poussé par quelqu'un d'autre est laissé à la charge d'une personne.

Comment une autorisation fusionne

Le plan de fusion dans l'Usine place un pull request couvert par une autorisation sous CoRoid peut fusionner maintenant, et le train de fusion l'intègre. Au moment de la fusion, CoRoid sollicite à nouveau le Mandat ; ainsi, une pause, un blocage, une limite atteinte ou un nouveau commit depuis l'établissement du plan peuvent l'arrêter.

Le commit de fusion porte le nom de l'autorisation et sa version. Cette fusion compte pour l'autorisation, pour la personne désignée comme responsable dans l'Historique et dans les limites de l'autorisation.

En coulisses, le plan de fusion indique que l'autorisation fusionnera le pull request, et une personne prend la décision.

Annoncer et arrêter

Une autorisation précise comment elle vous informe d'une fusion :

  • D'abord, puis elle attend un Arrêt. Lorsque le train de fusion traite la demande de pull, la personne responsable de l'autorisation et celle qui a demandé le travail reçoivent une notification. CoRoid effectue la fusion à la fin de la fenêtre, par exemple après 10 minutes, sauf si quelqu'un clique sur Arrêter dans la notification ou dans le plan de fusion, ou, avec un compte associé, sur son message dans Slack ou Telegram. Un pull request arrêté attend l'intervention d'une personne.
  • Après chacune. Vous êtes informé lorsqu'elle a fusionné.

Associer vos comptes

Une autorisation pour personnes de confiance et les Approbations CoRoid doivent savoir quel compte GitHub ou GitLab vous appartient. L'arrêt dans Slack ou Telegram doit connaître votre compte Slack ou Telegram. Dans Profil → Comptes associés, associez-les tous ; la plateforme confirme l'opération. CoRoid conserve l'identifiant et le nom du compte, jamais un jeton. Pour GitLab, il conserve également un digest de chaque adresse e-mail que vous y avez confirmée (pas les adresses elles-mêmes), ce qui lui permet de savoir si un commit vous appartient ; réassociez-le après avoir ajouté une adresse e-mail. Désassocier supprime toutes ces associations. Lorsque votre organisation connecte un GitLab auto-hébergé, cet GitLab dispose d'une ligne propre une fois qu'un propriétaire ou administrateur l'a configuré (Associer les comptes des utilisateurs sur votre GitLab).

Objectifs

Un objectif précise vers quoi CoRoid travaille seul, dans quels projets, et quel budget il peut utiliser. Les versions antérieures appelaient les objectifs des mandats ; Objectifs les décrit en détail.

Un objectif donne à CoRoid un but et un budget. Les demandes provenant de vos systèmes que cet objectif traite sont initiées comme décrit dans Quand le travail commence. Le travail CoRoid gère lui-même les fichiers dans le cadre d'un objectif, comme un suivi lorsqu'une modification n'a pas atteint son résultat ; cela nécessite une autorisation active pour Démarrer le travail; jusqu'alors, il attend qu'une personne le lance. Les correctifs de Sécurité constituent l'exception : ils démarrent selon les paramètres propres à la Sécurité.

Limites

Ce que CoRoid ne peut jamais faire seul, quel que soit le contenu de l'autorisation :

  • Chemins protégés. Une personne décide de chaque modification sur ces chemins. CoRoid protège la connexion et l'accès, la facturation et les paiements, les secrets et identifiants, la cryptographie, les migrations de base de données, les fichiers de verrouillage, les pipelines CI, ainsi que les conteneurs et l'infrastructure ; vous pouvez également ajouter vos propres chemins. Seul un propriétaire peut supprimer l'une des protections définies par CoRoid, en justifiant sa décision.
  • Actions de livraison. Ce que toute autorisation peut faire au maximum : fusionner, déployer et revenir en arrière ; chaque action peut être autorisée, demandée ou refusée.
  • Demandes de pull ouvertes. Nombre de demandes de pull propres à CoRoid restées ouvertes dans un projet. Lorsque cette limite est atteinte, le travail qu'il lance seul attend ; une demande provenant d'une personne est toujours traitée en priorité.
  • Agents. Profondeur à laquelle un agent peut intervenir, et possibilité pour les automatisations et plannings de créer des tâches. La capacité de CoRoid Review à bloquer un pull request dépend d'une autorisation.

Historique

Chaque modification du Mandat et chaque décision prise dans son cadre, du plus récent au plus ancien : qui a publié ou modifié une autorisation, ce que CoRoid était autorisé ou non à faire et pourquoi, et les réponses des personnes aux sollicitations de CoRoid.

Quand CoRoid vous sollicite

Certaines actions nécessitent d'abord la réponse d'une personne. Chacune apparaît dans une ligne sous Besoin de vous dans l'Usine : ce que CoRoid demande de faire, où et pourquoi. Approuver une fois lui permet d'exécuter cette action une seule fois. Refuser l'empêche de l'exécuter. Consultez L'Usine.

Qui peut modifier cela

Les propriétaires et les administrateurs modifient le mandat. Les membres peuvent le consulter en entier. Les agents et comptes de service de CoRoid ne sont pas du tout autorisés à le modifier.

Chaque décision prise dans le cadre d'une attribution est également enregistrée dans le flux d'audit de votre organisation, au nom de CoRoid, avec l'attribution et sa version associée.