ForHosting KIT · Outils pour développeurs

Validateur de noms de branches git

Indiquez le nom de la branche et votre modèle : feature/ABC-123-add-login face à type/ticket-description est valide et se découpe en type feature, ticket ABC et description 123-add-login. Sinon, le message cite la branche et le modèle côte à côte. Gratuit dans votre navigateur.

  • Gratuit
  • Fonctionne dans votre navigateur
  • Sans inscription
  • Vos données restent sur votre appareil
Utilisez-le depuis WebAPIE-mailTelegramApp bientôt
Si vous saisissez
Branche
feature/ABC-123-add-login
Convention
type/ticket-description
Vous obtenez
Noms des composants
type, ticket, description
Nombre de composants
3

Les équipes qui partagent un monorepo ou un dépôt produit de longue durée s’accordent en général sur une convention de noms de branches afin que les bots de revue, les scripts de release et les liens de tickets analysent chaque ref sans deviner. Un motif typique ressemble à type barre ticket tiret description—par exemple feature/ABC-123-add-login—mais chaque organisation invente ses séparateurs et l’ordre des composants. Ce validateur de convention de noms de branches git accepte la chaîne de la branche et votre modèle de convention, vérifie que le nom entier correspond du début à la fin et renvoie chaque composant nommé pour que la CI, les hooks et les tableaux de bord appliquent la politique sans regex fragiles à usage unique.

Fonctionnement du motif de convention et extractions

Une convention est un court modèle composé de noms de placeholders et de séparateurs littéraux. Les placeholders sont des identifiants ordinaires : ils commencent par une lettre ou un souligné et se poursuivent par des lettres, des chiffres ou des soulignés. Tout le reste du modèle est un séparateur qui doit apparaître littéralement dans le nom de branche.

L’exemple classique type/ticket-description désigne donc trois composants—type, ticket et description—reliés par une barre puis un tiret. Lorsque vous envoyez la branche feature/ABC-add-login avec cette convention, le validateur renvoie type égal à feature, ticket égal à ABC et description égal à add-login. Le composant final peut contenir les mêmes caractères que des séparateurs antérieurs, de sorte que des slugs multi-mots comme add-user-login restent dans description plutôt que d’être tronqués au premier tiret.

Les noms de composants dans une convention doivent être uniques ; le motif doit commencer et finir par un placeholder ; placeholders et séparateurs doivent alterner. Ces règles gardent le moteur de correspondance déterministe et évitent les captures ambiguës.

Porte CI pour les pull requests

Rejetez les branches de PR qui ne correspondent pas à type/ticket-description avant les builds et tests coûteux.

Hooks pre-commit et onboarding

Enseignez aux développeurs le motif de nommage maison en local avec le même moteur pur que le serveur.

Automatisation tickets et changelog

Extrayez les composants ticket et type du nom de branche pour mettre à jour les trackers et choisir les sections du changelog.

Que se passe-t-il si le nom de branche est vide ?

Un nom de branche vide ou uniquement composé d’espaces n’est jamais accepté et n’est pas facturé.

La partie description peut-elle contenir des tirets ?

Oui. Le placeholder final capture le suffixe restant, donc add-user-login reste dans le dernier composant lorsque le séparateur précédent est un seul tiret.

Le validateur impose-t-il une liste fixe de types de branches ?

Non. Il vérifie la structure et extrait les composants. Appliquez votre propre liste autorisée sur le composant type si vous n’acceptez que feature, fix, chore et des libellés similaires.

Pourquoi le ticket ressort-il en ABC et non en ABC-123 ?

Dans type/ticket-description, le ticket s'arrête au premier tiret, car ce tiret est le séparateur qui précède la description. Tout ce qui suit, 123-add-login, revient à la dernière partie, qui peut contenir ses propres tirets.

Quels caractères font échouer un nom de branche ?

Les espaces, les points consécutifs, la ponctuation interdite par git et les caractères de contrôle. Un nom vide ou composé uniquement d'espaces est aussi refusé, car git ne peut pas créer de branche sans nom.

Tout sur cette page est disponible par programmation. Cette section s'adresse aux équipes qui veulent l'intégrer à leurs systèmes ; les autres peuvent simplement utiliser l'outil ci-dessus.

POSThttps://api.kit.forhosting.com/dev/git-branch-name-validate

Authentification par jeton Bearer : un seul POST met la tâche en file d’attente, et le résultat vous parvient par webhook ou lien signé.

curl -X POST https://api.kit.forhosting.com/dev/git-branch-name-validate \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"branch":"feature/ABC-123-add-login","convention":"type/ticket-description"}'
{
  "branch": "feature/ABC-123-add-login",
  "convention": "type/ticket-description"
}
{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "dev.git_branch_name_validate",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

L’API est asynchrone : chaque appel renvoie un task_id immédiatement, puis vous interrogez l’état à raison d’une requête par seconde.

par requête$0.002

Le prix est publié, sans tokens ni crédits. Une tâche qui échoue n’est pas facturée.

HTTPCodeSignification
401unauthorizedClé API absente ou invalide : vérifiez l’en-tête Authorization.
402insufficient_balanceSolde insuffisant : rechargez votre compte pour lancer cette tâche.
404unknown_typeType de tâche inconnu : vérifiez le champ type de votre requête.
429rate_limitedTrop de requêtes : ralentissez la cadence, puis réessayez.

Les noms vides échouent avec invalid_input, tout comme les caractères de ref git peu sûrs courants : espaces, points consécutifs et ponctuation interdite.

Fonctionnement du motif de convention et extractions

Si la branche ne correspond pas au motif entier, la tâche échoue avec invalid_input et un message qui cite la branche et la convention pour que les développeurs corrigent le nom ou la politique d’un seul coup d’œil.

Contrat d’entrée, contrôles de sécurité et forme de la réponse

Les caractères de contrôle sont aussi rejetés. Les clés de sortie optionnelles sont omises plutôt que mises à null. L’échec de validation n’est pas facturé. Associez la réponse à votre propre couche de politique si vous avez besoin d’une liste autorisée de valeurs de type comme feature, fix, chore ou release ; cette capacité vérifie la structure et extrait les parties, elle ne code pas en dur le vocabulaire d’une seule organisation. Envoyez en POST un corps JSON avec deux chaînes obligatoires : branch, le nom candidat de la branche git, et convention, le modèle de nommage. Des alias sont acceptés pour la commodité—branch_name, name et ref pour le champ branche ; pattern, format et template pour le champ convention—mais les noms canoniques figurent dans la documentation et les SDK. Les deux champs doivent être non vides après rejet des seuls espaces ; une branche vide est toujours invalid_input car git ne peut pas créer une ref de longueur nulle et l’automatisation qui oublie de passer le nom doit échouer de façon fermée. En cas de succès le corps inclut valid true, la branche et la convention renvoyées en écho, un objet components associant chaque nom de placeholder à sa valeur capturée, component_names dans l’ordre du modèle et component_count.

Où un validateur de noms de branches apporte de la valeur

Les jobs d’intégration continue utilisent un validateur de convention de noms de branches git comme première étape d’un pipeline afin que les pull requests ouvertes avec des noms ad hoc n’atteignent jamais les étapes de build coûteuses. L’automatisation de release extrait le composant ticket pour ouvrir ou mettre à jour des tickets du tracker, et extrait le composant type pour choisir les sections du changelog sans hacks fragiles de sous-chaînes. Les sites de contenu qui se positionnent sur validateur de convention de noms de branches git bénéficient d’un formulaire en direct dont le chemin gratuit correspond octet par octet au chemin d’automatisation payant. Les équipes plateforme qui gèrent de nombreux dépôts publient une seule chaîne de convention dans leur portail développeur et pointent chaque modèle, bot et checklist vers cet endpoint, de sorte qu’un changement de politique soit une seule édition de chaîne plutôt qu’une chasse dans des scripts shell. Comme l’implémentation est pure parse de niveau A, chaque appel réussi coûte le prix de base publié $0.002 sans tokens de modèle et sans réseau sortant.

Comment valider une branche git face à une convention de noms ?

Envoyez branch (par exemple feature/ABC-add-login) et convention (par exemple type/ticket-description). En cas de succès l’API renvoie valid true et une carte components avec chaque partie nommée.

Combien coûte le validateur de noms de branches git ?

L’outil navigateur est gratuit. Les requêtes API utilisent le solde KIT prépayé à $0.002 par appel réussi ; l’entrée invalide n’est pas facturée.

Consulter la documentation complète du KIT →