Aller au contenu principal

GitHub Actions

L'action mankinds/cli déclenche un agent Mankinds, attend le résultat du quality gate et échoue le workflow quand le gate échoue.

1. Ajoutez la clé API en secret de repo​

Dans votre repo :

  1. Settings → Secrets and variables → Actions → New repository secret.
  2. Nom : MANKINDS_API_KEY.
  3. Valeur : la clé copiée depuis Mankinds (Settings → API Keys → Create key).

La clé complète n'est affichée qu'une seule fois à la création : collez-la maintenant ou renouvelez-la si vous l'avez ratée.

2. Posez le fichier workflow​

Créez .github/workflows/mankinds-ci.yml à la racine de votre repo :

name: Mankinds quality gate
on:
  pull_request:
    branches: [main]
jobs:
  eval:
    runs-on: ubuntu-latest
    steps:
      - uses: mankinds/cli@v1
        with:
          agent: 00000000-0000-4000-8000-000000000000
          api-key: ${{ secrets.MANKINDS_API_KEY }}

Remplacez 00000000-0000-4000-8000-000000000000 par l'UUID de votre agent Mankinds. La page CI Integration de l'agent génère un snippet pré-rempli avec le bon UUID et la bonne base URL.

3. Exiger le check sur les branches protégées (optionnel)​

Si vous voulez que le gate bloque réellement un merge :

  1. Settings → Branches → Branch protection rules → Add rule sur main.
  2. Require status checks to pass before merging.
  3. Cochez Mankinds quality gate dans la liste des checks requis.

Le premier run après l'ajout du workflow enregistre le nom du check auprès de GitHub. Lancez un run avant d'ajouter la règle de protection.

Options​

Les inputs requis sont agent et api-key. Les inputs optionnels sont :

  • base-url : remplace https://app.mankinds.io pour un autre déploiement.
  • timeout-minutes : temps maximum d'attente avant échec de l'action.
  • comment-on-pr : active ou désactive le résumé de PR quand le workflow s'exécute sur une pull request.

Sécurité​

  • Stockez la clé API comme secret GitHub, jamais en clair dans le workflow.
  • Épinglez l'action sur un tag majeur comme mankinds/cli@v1.
  • L'action envoie les métadonnées CI à Mankinds pour rendre le run traçable. Elle n'envoie pas votre code source.
  • L'endpoint du système évalué doit être accessible depuis Mankinds.

Troubleshooting​

Pour 401, vérifiez la valeur du secret et les droits de la clé. Pour 404, vérifiez l'UUID de l'agent et l'organisation. Pour gate_not_configured, configurez le quality gate sur l'agent puis relancez le workflow.

Voir aussi​