dynamics-unlimited/composer-git-flow-plugin

(Fork of ichhabrecht/composer-git-flow-plugin) This plugin allows to use repositories using the Git Flow workflow (or any other branching model) with Composer

2.3.0 2024-02-12 11:08 UTC

Requires

• php: ^5.5 || ^7.0 || ^8.0
• composer-plugin-api: ^2.0

Requires (Dev)

• composer/composer: ^2.0

MIT

• Nicolas GIROD

README

This plugin allows to use repositories using the Git Flow workflow (or any other branching model) with Composer.

Installation

First you have to require the plugin.

$ composer require dynamics-unlimited/composer-git-flow-plugin

Usage

To define the repositories for which the plugin should change the used branch, it is necessary to require those with dev-master constraint.

{
  "repositories": [
    {
      "type": "vcs",
      "url": "[path-to-your-repository]"
    }
  ],
  "require": {
    "vendor/package": "dev-master"
  }
}

To select the branch your repositories should use, you have to call the composer command git-flow-update which makes sure only repositories with dev-master dependency constraints are updated. To specify the branch prefix use the option stability of the command.

$ composer git-flow-update --stability develop

If you want to checkout your repositories with the latest release branch you can simply set the stability to release. The plugin searches for any available branch with the stability prefix with a fallback to master branch if no other suitable branch was found.