Composerでgit上のLibraryを使いたい時のメモ

はじめに

PHPのComposerでGit上のライブラリを使いたい時のメモです。
下記を見ればわかる
https://getcomposer.org/doc/05-repositories.md#vcs
のですが、Composer初心者には当たり前のお約束もわからなかったので残しておきます。

今回やりたかったこと

• 「とあるPHPのComposerライブラリ」をForkして今後ややカスタマイズしつつ使いたい
• なので、Github上でForkしてそれをcomposer経由で取ってきたい

どうしたか

こう書けばOKだった

composer.json

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/yumemi/oauth2-server-php"
    }
  ],
  "require": {
    "bshaffer/oauth2-server-php": "dev-feature/oidc"
  }
}

として

composer install

でOKでした。

何に躓いたのか

repositoriesの書き方

まず repositories の部分で {"type": "vcs", "url": "<gitURL>"} で良かった。

＞ もっとごにょごにょ書いてた・・・

package名

bshaffer/oauth2-server-php の部分は、 oauth2-server-phpの中の composer.jsonの中のname を使う必要があった。

＞GitのDIR名ではなかった

使いたいブランチ名

参照したいブランチ名を dev-<本当のGitブランチ名> にする必要があった。

＞ feature/oidc とかにしたり dev-oidcというブランチをPushしてたけど、それが間違い。
＞ dev- という Prefixを用いてその後ろに ちゃんと存在するBranch名を指定すれば良かった。
ex) dev-master → Git上の master Branchのこと
ex) dev-develop → Git上の develop Branchのこと

さいごに

ドキュメントをななめ読みする人向けのTipsでした・・・(^^;