Utiliser une branche Github avec Composer

Cet article a été publié depuis plus de 6 mois, cela signifie que le contenu peut ne plus être d'actualité.

Lorsque l'on travaille sur un projet avec de multiples dépendances, il arrive que l'on soit amené à faire évoluer l'une d'entre elles pour les besoins de notre développement. Nous devons alors spécifier à Composer sur qu'elle branche il doit travailler.

Pour cela, nous allons prendre pour exemple une dépendance récupérée depuis un dépôt Github (le fonctionnement est similaire pour tout autre dépôt, via un Satis par exemple).

Il faut donc tout d'abord spécifier à Composer sur quel dépôt il va devoir travailler. Cette configuration se fait au travers d'une section "repositories" à ajouter dans le fichier composer.json.

{
    // ...

    "repositories": [
        {
            "type": "git",
            "url": "https://github.com/jdecool/my-lib"
        }
    ],

    // ...
}

Une fois le dépôt spécifié, il ne reste plus qu'à indiquer la branche de travail de votre dépendance.

{
    // ...

    "require": {
        // ...
        "vendor/my-lib": "dev-my-branch"
    },

    // ...
}

Vous pouvez maintenant effectuer un composer update vendor/my-lib pour mettre à jour la dépendance avec la branche du dépôt que vous venez de configurer.