setup phpダウンロード - setup phpソースコードのダウンロード

必要な拡張機能、php.ini 設定、コードカバレッジサポート、GitHub Actions のコンポーザーなどのさまざまなツールを使用して PHP をセットアップします。このアクションにより、アプリケーションのテストに必要な PHP 環境をセットアップするためのクロスプラットフォームインターフェイスが提供されます。これの使用方法については、「使用法」セクションと例を参照してください。

コンテンツ

OS/プラットフォームのサポート
- GitHub でホストされるランナー
- 自己ホスト型ランナー
PHPサポート
PHP 拡張機能のサポート
ツールのサポート
カバレッジサポート
- Xデバッグ
- PCOV
- カバレッジを無効にする
使用法
- 入力
- 出力
- フラグ
- 基本的なセットアップ
- マトリックスのセットアップ
- 夜間のビルドセットアップ
- デバッグビルドセットアップ
- スレッドセーフ設定
- 強制アップデートセットアップ
- 詳細なセットアップ
- マルチアーチのセットアップ
- セルフホスト型セットアップ
- ローカルテストのセットアップ
- JIT構成
- キャッシュ拡張機能
- キャッシュ・コンポーザーの依存関係
- GitHub Composer 認証
- プライベート Packagist 認証
- 手動作曲者認証
- インライン PHP スクリプト
- 問題マッチャー
- 例
バージョン管理
ライセンス
貢献
このプロジェクトをサポートする
依存関係
さらに読む

OS/プラットフォームのサポート

GitHub-hostedとself-hostedランナーの両方が、次の OS/プラットフォーム上のsetup-phpでサポートされています。

GitHub でホストされるランナー

仮想環境	YAML ワークフローラベル	プリインストールされたPHP
Ubuntu 24.04	`ubuntu-24.04`	`PHP 8.3`
Ubuntu 22.04	`ubuntu-latest`または`ubuntu-22.04`	`PHP 8.1`
Ubuntu 20.04	`ubuntu-20.04`	`PHP 7.4`から`PHP 8.3`へ
Windowsサーバー2022	`windows-latest`または`windows-2022`	`PHP 8.3`
Windowsサーバー2019	`windows-2019`	`PHP 8.3`
macOS セコイア 15.x	`macos-15`	-
macOS ソノマ 14.x	`macos-latest`または`macos-14`	-
macOS ベンチュラ 13.x	`macos-13`	`PHP 8.3`

自己ホスト型ランナー

ホストOS/仮想環境	YAML ワークフローラベル
Ubuntu 24.04	`self-hosted`または`Linux`
Ubuntu 22.04	`self-hosted`または`Linux`
Ubuntu 20.04	`self-hosted`または`Linux`
デビアン 12	`self-hosted`または`Linux`
デビアン 11	`self-hosted`または`Linux`
Windows 7 以降	`self-hosted`または`Windows`
Windows Server 2012 R2 以降	`self-hosted`または`Windows`
macOS セコイア 15.x x86_64/arm64	`self-hosted`または`macOS`
macOS Sonoma 14.x x86_64/arm64	`self-hosted`または`macOS`
macOS ベンチュラ 13.x x86_64/arm64	`self-hosted`または`macOS`

セルフホストランナーでアクションを使用するには、セルフホストのセットアップを参照してください。
上記の Ubuntu および Debian バージョンに基づくオペレーティングシステムもベストエフォートベースでサポートされます。
要求された PHP バージョンがプレインストールされている場合、 setup-phpそのバージョンに切り替えます。そうでない場合は、PHP バージョンをインストールします。

PHPサポート

サポートされているすべての OS/プラットフォームで、次の PHP バージョンをランナーごとにセットアップできます。

GitHub でホストされているランナー上の PHP 5.3 から PHP 8.5 (macOS ARM64 ランナー (macos-14) を除く)。
GitHub でホストされている macOS ARM64 ランナー (macos-14) 上の PHP 5.6 から PHP 8.5。
セルフホストランナー上の PHP 5.6 から PHP 8.5。

PHPのバージョン	安定性	リリースサポート	ランナーサポート
`5.3`	`Stable`	`End of life`	`GitHub-hosted`
`5.4`	`Stable`	`End of life`	`GitHub-hosted`
`5.5`	`Stable`	`End of life`	`GitHub-hosted`
`5.6`	`Stable`	`End of life`	`GitHub-hosted` 、 `self-hosted`
`7.0`	`Stable`	`End of life`	`GitHub-hosted` 、 `self-hosted`
`7.1`	`Stable`	`End of life`	`GitHub-hosted` 、 `self-hosted`
`7.2`	`Stable`	`End of life`	`GitHub-hosted` 、 `self-hosted`
`7.3`	`Stable`	`End of life`	`GitHub-hosted` 、 `self-hosted`
`7.4`	`Stable`	`End of life`	`GitHub-hosted` 、 `self-hosted`
`8.0`	`Stable`	`End of life`	`GitHub-hosted` 、 `self-hosted`
`8.1`	`Stable`	`Security fixes only`	`GitHub-hosted` 、 `self-hosted`
`8.2`	`Stable`	`Active`	`GitHub-hosted` 、 `self-hosted`
`8.3`	`Stable`	`Active`	`GitHub-hosted` 、 `self-hosted`
`8.4`	`Stable`	`Active`	`GitHub-hosted` 、 `self-hosted`
`8.5`	`Nightly`	`In development`	`GitHub-hosted` 、 `self-hosted`

注:

php-version入力で8.5指定すると、 PHP 8.5.0-devの夜間ビルドがインストールされます。詳細については、夜間ビルドのセットアップを参照してください。
PHP 8.0以降で JIT を使用するには、「JIT 構成」セクションを参照してください。

PHP 拡張機能のサポート

PHP 拡張機能は、 extensions入力を使用して設定できます。 CSV 形式のstringを受け入れます。

Ubuntuでは、パッケージとして利用可能な拡張機能、 PECLまたは git リポジトリで利用可能な拡張機能をセットアップできます。

- name : Setup PHP with PECL extension
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    extensions : imagick, swoole

Windowsでは、 DLLバイナリを持つPECLで利用可能な拡張機能をセットアップできます。
macOSでは、 PECLまたは git リポジトリで利用可能な拡張機能をセットアップできます。
UbuntuおよびmacOSで git リポジトリから拡張機能をコンパイルしてインストールするには、このガイドに従ってください。
指定されている場合、PHP とともにインストールされる拡張機能が有効になります。
PECLで利用可能な拡張機能の特定のバージョンは、拡張機能の名前の末尾にバージョンを付けることで設定できます。これは、サポートが終了した PHP バージョンをサポートする古いバージョンの拡張機能をインストールする場合に役立ちます。

- name : Setup PHP with specific version of PECL extension
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 5.4 '
    extensions : swoole-1.9.3

PECLで利用可能なプレリリースバージョンの拡張機能は、拡張機能の名前にその状態 ( alpha 、 beta 、 devel 、またはsnapshotを接尾辞として付けることでセットアップできます。

- name : Setup PHP with pre-release PECL extension
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    extensions : xdebug-beta

UbuntuおよびmacOSで、ライブラリまたはカスタム構成を使用して PECL から拡張機能をコンパイルしてインストールするには、このガイドに従ってください。
共有拡張機能は、先頭に:を付けることで無効にできます。指定された拡張子に依存するすべての拡張子も無効になります。

- name : Setup PHP and disable opcache
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    extensions : :opcache

none指定すると、すべての共有拡張機能を無効にできます。他の拡張子とともにnone指定されていない場合は、入力の先頭にホイストされます。したがって、最初にすべての共有拡張機能が無効になり、その後、入力内の残りの拡張機能が処理されます。

注:これにより、すべてのコアおよびサードパーティの共有拡張機能が無効になるため、それらを必要とする一部のツールが機能しなくなる可能性があります。ツールがベストエフォートベースでセットアップされると、必要な拡張機能が再び有効になります。したがって、問題を避けるために、 extensions入力にnone追加しなかった後に、ツールに必要な拡張機能を追加することをお勧めします。

- name : Setup PHP without any shared extensions except mbstring
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    extensions : none, mbstring

拡張子intl intlにICUバージョンを付けることで、 UbuntuワークフローのPHP 5.6以降の特定のICUバージョンで設定できます。 ICU 50.2以降のバージョンがサポートされています。サポートされている特定のバージョンについては、 ICU buildsを参照してください。

- name : Setup PHP with intl
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    extensions : intl-70.1

setup-phpの実行後にデフォルトでロードされる拡張機能は wiki にあります。
これらの拡張機能にはカスタムサポートがあります。
- Ubuntu上のcubridとpdo_cubrid 。
- UbuntuおよびmacOS上のevent 、 gearman 、 geosおよびrelay 。
- サポートされているすべての OS 上のblackfire 、 couchbase 、 ioncube 、 oci8 、 pdo_firebird 、 pdo_oci 、 pecl_http 、 phalcon3 、 phalcon4 、 phalcon5 、およびzephir_parser 。
デフォルトでは、追加または無効にできない拡張機能はログにエラーメッセージを残し、実行は中断されません。この動作を変更するにはfail-fastフラグをtrueに設定します。

- name : Setup PHP with fail-fast
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    extensions : oci8
  env :
    fail-fast : true

ツールのサポート

これらのツールは、 tools入力を使用してグローバルに設定できます。 CSV 形式の文字列を受け入れます。

behat 、 blackfire 、 blackfire-player 、 box 、 castor 、 churn 、 codeception 、 composer 、 composer-dependency-analyser 、 composer-normalize 、 composer-prefetcher 、 composer-require-checker 、 composer-unused 、 cs2pr 、 deployer 、 ecs 、 flex 、 grpc_php_plugin 、 infection 、 parallel-lint 、 pecl 、 phan 、 phing 、 phinx 、 phive 、 php-config 、 php-cs-fixer 、 php-scoper 、 phpcbf 、 phpcpd 、 phpcs 、 phpdocまたはphpDocumentor 、 phpize 、 phplint 、 phpmd 、 phpspec 、 phpstan 、 phpunit 、 phpunit-bridge 、 phpunit-polyfills 、 pint 、 prestissimo 、 protoc 、 psalm 、 rector 、 symfonyまたはsymfony-cli 、 vaporまたはvapor-cli 、 wpまたはwp-cli

- name : Setup PHP with tools
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    tools : php-cs-fixer, phpunit

上記のツールに加えて、Packagist のリストに一致するvendor/packageとして指定することで、コンポーザーツールまたはパッケージをグローバルにセットアップすることもできます。この形式は、 composerと同じバージョン制約を受け入れます。

- name : Setup PHP with tools
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    tools : vimeo/psalm

ツールの特定のバージョンを設定するには、 tool:versionの形式で指定します。
バージョンは次の形式にすることができます。
- センバー。たとえば、 tool:1.2.3またはtool:1.2.3-beta1です。
- メジャーバージョン。たとえば、 tool:1またはtool:1.xです。
- メジャーバージョンとマイナーバージョン。たとえば、 tool:1.2またはtool:1.2.xです。
メジャーバージョンのみ、またはメジャー. major.minor形式でバージョンを指定した場合は、入力に一致する最新のパッチバージョンがセットアップされます。
composerのメジャーバージョンを除き、ツールにmajorバージョンのみ、またはmajor.minor形式のバージョンを指定すると、GitHub の API によってレート制限を受ける可能性があります。これを回避するには、 GitHub OAuth トークンを提供することをお勧めします。これを行うには、 GITHUB_TOKEN環境変数を設定します。 COMPOSER_TOKEN環境変数はGITHUB_TOKENに代わって非推奨となり、次のメジャーバージョンでは削除される予定です。

- name : Setup PHP with tools
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    tools : php-cs-fixer:3.64, phpunit:11.4
  env :
    GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}

composerの最新の安定バージョンがデフォルトでセットアップされています。メジャーバージョンv1またはv2 、またはmajor.minorまたはsemver形式のバージョンを指定することで、必要なcomposerバージョンをセットアップできます。さらに、コンポーザーのsnapshotとpreview指定して、それぞれのリリースを設定することもできます。

- name : Setup PHP with composer v2
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    tools : composer:v2

ワークフローでコンポーザーを使用しない場合は、 tools: noneを指定してスキップできます。

- name : Setup PHP without composer
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    tools : none

Linux および macOS でサポートされているすべての PHP バージョンに対して、ツールpear 、 pecl 、 phpizeおよびphp-configデフォルトで設定されています。
blackfire cli の最新バージョンは、ツール入力でblackfire指定するとセットアップされます。 GitHub Actions でblackfire使用する方法については、公式ドキュメントを参照してください。
ツールの入力でcomposer:v1も指定されていない限り、ツールprestissimoとcomposer-prefetcherスキップされます。 prestissimo削除し、 composer v2使用することをお勧めします。
デフォルトでは、正常にセットアップできないcomposerツールを除き、エラーメッセージがログに残され、実行は中断されません。この動作を変更するにはfail-fastフラグをtrueに設定します。

- name : Setup PHP with fail-fast
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    tools : deployer
  env :
    fail-fast : true

注意事項

入力tools CI ワークフローでのみ使用されるツールをセットアップするのに便利で、 composer.json整然とした状態に保ちます。
ワークフローですべての開発依存関係を使用したくない場合は、 --no-devを指定して Composer を実行し、 tools入力を使用して必要なツールをインストールして、ワークフローを高速化できます。
デフォルトでは、 COMPOSER_NO_INTERACTIONは1に設定され、 COMPOSER_PROCESS_TIMEOUTは0に設定されます。実際、これは、スクリプト内の Composer コマンドで--no-interaction指定する必要がないことを意味します。
また、 COMPOSER_NO_AUDITは1に設定されます。したがって、依存関係のセキュリティ脆弱性を監査する場合は、依存関係をインストールする前にcomposer auditステップを追加することをお勧めします。
別のCOMPOSER_PROCESS_TIMEOUTを設定する場合は、 envキーワードを使用してワークフローファイルに設定できます。

- name : Setup PHP with composer and custom process timeout
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
  env :
    COMPOSER_PROCESS_TIMEOUT : 300

カバレッジサポート

Xデバッグ

Xdebugを使用し、 PCOV無効にするには、 coverage: xdebugを指定します。
サポートされているすべての PHP バージョンで実行します。

- name : Setup PHP with Xdebug
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    coverage : xdebug

coverage: xdebug指定すると、PHP バージョンと互換性のある最新バージョンの Xdebug がデフォルトでセットアップされます。
PHP 7.2、7.3、または 7.4 で Xdebug 2.x が必要な場合は、 coverage: xdebug2指定できます。

- name : Setup PHP with Xdebug 2.x
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 7.4 '
    coverage : xdebug2

注: Xdebug は、Ubuntu GitHub Actions イメージではデフォルトで有効になっているため、ワークフローで Xdebug を使用していない場合は、PHP のパフォーマンスにプラスの影響を与えるため、無効にすることをお勧めします。詳細については、「カバレッジを無効にする」セクションを参照してください。

PCOV

coverage: pcov指定してPCOV使用し、 Xdebug無効にします。
PHP 7.1 以降の PHP バージョンで実行されます。

ソースコードディレクトリがsrc 、 lib 、 app以外の場合は、 ini-values入力を使用してpcov.directory指定します。

- name : Setup PHP with PCOV
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    ini-values : pcov.directory=api # optional, see above for usage.
    coverage : pcov

PHPUnit 8.x 以降は、そのままの状態で PCOV をサポートします。
PHPUnit 5.x、6.x、または 7.x を使用している場合は、テストを実行する前にpcov/clobberセットアップする必要があります。

- name : Setup PCOV
  run : |
    composer require pcov/clobber
    vendor/bin/pcov clobber

カバレッジを無効にする

XdebugとPCOV両方を無効にするには、 coverage: noneを指定します。

次の理由によりカバレッジを無効にします。

テスト中にカバレッジレポートは生成されません。
テストの実行にはphpdbg使用しています。
blackfireを使用してコードをプロファイリングしています。
PHP を JIT モードで使用しています。詳細については、「JIT 構成」セクションを参照してください。

- name : Setup PHP with no coverage driver
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    coverage : none

使用法

入力

キーワードwith指定する

`php-version` (オプション)

設定したいPHPのバージョンを指定します。
stringを受け入れます。たとえば、 '8.4'です。
サポートされている最も低い PHP バージョンをセットアップするには、 lowestを受け入れます。
最新の安定した PHP バージョンをセットアップするには、 highestまたはlatest受け入れます。
PHP のマスターブランチから夜間ビルドをセットアップするためにnightly受け入れます。
dxという形式を受け入れます。ここで、 dはメジャーバージョンです。たとえば、 5.x 、 7.x 、 8.xなどです。
サポートされている PHP バージョンについては、「PHP サポート」を参照してください。
指定しない場合、次のものが順番に検索されます。
- php-version-file入力 (存在する場合)
- composer.lockファイルとplatform-overrides.php値
- composer.jsonファイルとconfig.platform.php値

`php-version-file` (オプション)

セットアップする PHP バージョンのファイルを指定します。
stringを受け入れます。たとえば、 '.phpenv-version'です。
サポートされている PHP バージョンについては、「PHP サポート」を参照してください。
デフォルトでは、 .php-versionファイルが使用されます。
指定されておらず、デフォルトの.php-versionファイルが見つからない場合は、最新の安定した PHP バージョンがセットアップされます。

`extensions` (オプション)

追加または無効にする拡張機能を指定します。
CSV 形式のstringを受け入れます。たとえば、 mbstring, :opcache 。
すべての共有拡張機能を無効にする場合はnone受け入れます。
:の接頭辞が付いた共有拡張子は無効になります。
詳細については、「PHP 拡張機能のサポート」を参照してください。

`ini-file` (オプション)

ベースとなるphp.iniファイルを指定します。
production 、 development 、またnone受け入れます。
デフォルトでは、実稼働用のphp.iniファイルが使用されます。

`ini-values` (オプション)

php.iniに追加する値を指定します。
CSV 形式のstringを受け入れます。たとえば、 post_max_size=256M, max_execution_time=180などです。
引用符で囲んだ場合は、カンマを含む ini 値を受け入れます。たとえば、 xdebug.mode="develop,coverage" 。

`coverage` （オプション）

セットアップするコードカバレッジドライバーを指定します。
xdebug 、 pcov 、またはnone受け入れます。
詳細については、カバレッジのサポートを参照してください。

`tools` （オプション）

セットアップするツールを指定します。
CSV 形式のstringを受け入れます。例: phpunit, phpcs
サポートされているツールについては、「ツールのサポート」を参照してください。

出力

`php-version`

GitHub Actions では、 setup-phpステップにid割り当てることができ、同じものを使用して後のステップで出力を取得できます。

PHP バージョンを semver 形式で提供します。

- name : Setup PHP
  id : setup-php
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '

- name : Print PHP version
  run : echo ${{ steps.setup-php.outputs.php-version }}

フラグ

envキーワードで指定

`fail-fast` (オプション)

拡張機能またはツールのセットアップが失敗した場合に、ワークフローを失敗としてマークするように指定します。
これにより、デフォルトモードが正常な警告からフェイルファストに変更されます。
デフォルトでは、 falseに設定されています。
trueとfalse受け入れます。

`phpts` (オプション)

PHP のスレッドセーフビルドをセットアップするように指定します。
非スレッドセーフの場合はnts受け入れ、スレッドセーフの場合はztsまたはts受け入れます。
デフォルトでは、 ntsに設定されます。
詳細については、「スレッドセーフ設定」を参照してください。

`update` （オプション）

ランナー上の PHP を最新のパッチバージョンに更新するように指定します。
trueとfalse受け入れます。
デフォルトでは、 falseに設定されています。
詳細については、「強制更新セットアップ」を参照してください。

詳細については、以下を参照してください。

基本的なセットアップ

特定の PHP バージョンをセットアップします。

 steps :
- name : Setup PHP
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    extensions : mbstring, intl
    ini-values : post_max_size=256M, max_execution_time=180
    coverage : xdebug
    tools : php-cs-fixer, phpunit

マトリックスのセットアップ

複数のオペレーティングシステム上で複数の PHP バージョンをセットアップします。

 jobs :
  run :
    runs-on : ${{ matrix.operating-system }}
    strategy :
      matrix :
        operating-system : ['ubuntu-latest', 'windows-latest', 'macos-latest']
        php-versions : ['8.2', '8.3', '8.4']
        phpunit-versions : ['latest']
        include :
          - operating-system : ' ubuntu-latest '
            php-versions : ' 8.1 '
            phpunit-versions : 10
    steps :
    - name : Setup PHP
      uses : shivammathur/setup-php@v2
      with :
        php-version : ${{ matrix.php-versions }}
        extensions : mbstring, intl
        ini-values : post_max_size=256M, max_execution_time=180
        coverage : xdebug
        tools : php-cs-fixer, phpunit:${{ matrix.phpunit-versions }}
      env :
        GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}

夜間のビルドセットアップ

PHP 8.5の夜間ビルドをセットアップします。

これらの PHP バージョンは現在開発中であるため、バグや重大な変更が含まれる可能性があります。
一部のユーザー空間拡張機能は現在このバージョンをサポートしていない可能性があります。

 steps :
- name : Setup nightly PHP
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.5 '
    extensions : mbstring
    ini-values : post_max_size=256M, max_execution_time=180
    coverage : xdebug
    tools : php-cs-fixer, phpunit

デバッグビルドセットアップ

デバッグシンボルを使用して PHP ビルドをセットアップします。

デバッグシンボルのない PHP の実稼働リリースビルドは、デフォルトでセットアップされます。
debug環境変数を使用して、PHP 5.6 以降のデバッグシンボルを含むビルドをセットアップできます。

注意事項

Linux では、デバッグシンボルはデバッグ情報ファイルとして/usr/lib/debug/.build-idディレクトリに追加されます。これらのファイルは、PHP バイナリの ELF セクションのbuild-idと一致し、 gdbなどのデバッグツールはこれらのファイルのシンボルを解決できます。
Windows では、デバッグシンボルは PHP インストールディレクトリにpdbファイルとして追加されます。
macOS では、デバッグシンボルはバイナリにコンパイルされます。

 steps :
- name : Setup PHP with debugging symbols
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
  env :
    debug : true # specify true or false

スレッドセーフ設定

TSまたはNTS PHP をセットアップします。

NTSバージョンはデフォルトで設定されています。

 jobs :
  run :
    runs-on : [ubuntu-latest, windows-latest, macos-latest]
    name : Setup PHP TS
    steps :
    - name : Setup PHP
      uses : shivammathur/setup-php@v2
      with :
        php-version : ' 8.4 '
      env :
        phpts : ts # specify ts or nts

強制アップデートセットアップ

PHP バージョンの最新パッチに更新します。

プリインストールされた PHP バージョンは、デフォルトでは最新のパッチリリースに更新されません。
Ubuntu GitHub 環境でppa:ondrej/phpが見つからない場合、PHP バージョンは最新のパッチリリースに更新されます。
最新リリースに更新するには、 update環境変数をtrueに指定できます。

- name : Setup PHP with latest versions
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
  env :
    update : true # specify true or false

詳細なセットアップ

ワークフローをデバッグする

問題をデバッグするには、 v2代わりにverboseタグを使用できます。

- name : Setup PHP with logs
  uses : shivammathur/setup-php@verbose
  with :
    php-version : ' 8.4 '

マルチアーチのセットアップ

Ubuntu GitHub Runners 上の複数のアーキテクチャで PHP をセットアップします。

PHP 5.6からPHP 8.4は、 Ubuntu上の複数のアーキテクチャ上のsetup-phpによってサポートされています。
このために、 shivammathur/nodeイメージをコンテナとして使用できます。これらには、 setup-php用に互換性のあるNodejsがインストールされています。
現在、 ARMベースのセットアップにはセルフホストランナーが必要です。

 jobs :
  run :
    runs-on : ubuntu-latest
    container : shivammathur/node:latest-${{ matrix.arch }}
    strategy :
      matrix :
        arch : ["amd64", "i386"]
    steps :
      - name : Install PHP
        uses : shivammathur/setup-php@v2
        with :
          php-version : ' 8.4 '

セルフホスト型セットアップ

自己ホスト型ランナーに PHP をセットアップします。

コンテナ化されたセルフホストランナーを設定するには、ベースオペレーティングシステムに応じて次のガイドを参照してください。
- Linux
- 窓
ランナーをホスト OS または仮想マシンに直接セットアップするには、セルフホストランナーをセットアップする前に、この要件ガイドに従ってください。
ワークフローでサービスコンテナーを使用する場合は、Linux ホストまたは Linux 仮想マシン上にランナーをセットアップします。 GitHub Actions は Linux でのネストされた仮想化をサポートしていないため、サービスは Docker 化されたコンテナーでは機能しません。

セルフホスト環境の場合は、環境変数runnerに値self-hostedを指定することをお勧めします。

 jobs :
  run :
    runs-on : self-hosted
    strategy :
      matrix :
        php-versions : ['5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
    name : PHP ${{ matrix.php-versions }}
    steps :
    - name : Setup PHP
      uses : shivammathur/setup-php@v2
      with :
        php-version : ${{ matrix.php-versions }}
      env :
        runner : self-hosted

注意事項

並列ワークフローが互いに競合するため、単一のサーバーインスタンスに複数のセルフホストランナーをセットアップしないでください。
開発環境または運用サーバー側にセルフホストランナーをセットアップしないでください。
GitHub-hostedランナーで使用されているものと同じラベルをself-hostedランナーに使用することは避けてください。

ローカルテストのセットアップ

nektos/act使用してUbuntuワークフローをローカルでテストします。

 jobs :
  run :
    runs-on : ubuntu-latest
    steps :
    - name : Setup PHP
      uses : shivammathur/setup-php@v2
      with :
        php-version : ' 8.4 '

shivammathur/node docker イメージを使用して、 actを使用してワークフローをローカルで実行します。

ワークフローのruns-onプロパティに一致するイメージタグを選択します。たとえば、ワークフローでubuntu-20.04を使用している場合は、 act -P ubuntu-20.04=shivammathur/node:2004を実行します。

 # For runs-on: ubuntu-latest
act -P ubuntu-latest=shivammathur/node:latest

# For runs-on: ubuntu-24.04
act -P ubuntu-24.04=shivammathur/node:2404

# For runs-on: ubuntu-22.04
act -P ubuntu-22.04=shivammathur/node:2204

# For runs-on: ubuntu-20.04
act -P ubuntu-20.04=shivammathur/node:2004

JIT構成

PHP 8.0 以降でジャストインタイム (JIT) を有効にします。

JIT を有効にするには、 opcache.enable_cli=1を設定して、cli モードでopcache有効にします。
JIT は、 Xdebug 、 PCOV 、およびzend_execute_ex関数をオーバーライドするその他の拡張機能と競合するため、 coverage: noneを設定し、そのような拡張機能が追加されている場合は無効にします。
デフォルトでは、 opcache.jit=1235およびopcache.jit_buffer_size=256Mが設定されており、 ini-values入力を使用して変更できます。
JIT 関連のディレクティブの詳細については、 official PHP documentationを参照してください。

たとえば、バッファサイズが64 MBのtracingモードで JIT を有効にします。

- name : Setup PHP with JIT in tracing mode
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    coverage : none
    ini-values : opcache.enable_cli=1, opcache.jit=tracing, opcache.jit_buffer_size=64M

キャッシュ拡張機能

shivammathur/cache-extensionsおよびaction/cache GitHub Actions を使用して、PHP 拡張機能をキャッシュできます。キャッシュされるとセットアップに非常に時間がかかる拡張機能は、次回のワークフロー実行で使用可能になり、直接有効になります。これにより、ワークフローの実行時間が短縮されます。
詳細については、 shivammathur/cache-extensionsを参照してください。

キャッシュ・コンポーザーの依存関係

プロジェクトでコンポーザーを使用している場合は、コンポーザーの内部キャッシュディレクトリを永続化できます。キャッシュされた依存関係は、インストール中にダウンロードするのではなく、直接ロードされます。キャッシュされたファイルはチェック実行後も利用できるため、ワークフローの実行時間が短縮されます。

- name : Get composer cache directory
  id : composer-cache
  run : echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT

- name : Cache dependencies
  uses : actions/cache@v4
  with :
    path : ${{ steps.composer-cache.outputs.dir }}
    key : ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
    restore-keys : ${{ runner.os }}-composer-

- name : Install dependencies
  run : composer install --prefer-dist

注意事項

副作用があるため、 action/cache使用してvendorディレクトリをキャッシュしないでください。
composer.lockコミットしない場合は、 composer.jsonのハッシュをキャッシュのキーとして使用できます。

 key : ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}

さまざまなcomposerの依存関係をサポートし、 prefer-lowestおよびprefer-stableオプションを使用する場合、それらをマトリックスに保存してキーに追加できます。

 key : ${{ runner.os }}-composer-${{ matrix.prefer }}-${{ hashFiles('**/composer.lock') }}
restore-keys : ${{ runner.os }}-composer-${{ matrix.prefer }}-

GitHub Composer 認証

複数のツールをセットアップするワークフローが多数ある場合、またはコンポーザーへの依存関係が多数ある場合、コンポーザーに対する GitHub のレート制限に達する可能性があります。また、メジャーバージョンのみ、またはmajor.minor形式のバージョンのみを指定すると、レート制限に達する可能性があります。これを回避するには、 GITHUB_TOKEN環境変数を設定してOAuthトークンを指定します。この目的には、 GITHUB_TOKENシークレットを使用できます。

COMPOSER_TOKEN環境変数はGITHUB_TOKENに代わって非推奨となり、次のメジャーバージョンでは削除される予定です。

- name : Setup PHP
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
  env :
    GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}

プライベート Packagist 認証

プライベート Composer の依存関係に Private Packagist を使用する場合は、 PACKAGIST_TOKEN環境変数を設定して認証を行うことができます。

- name : Setup PHP
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
  env :
    PACKAGIST_TOKEN : ${{ secrets.PACKAGIST_TOKEN }}

手動作曲者認証

GitHub または Private Packagist に加えて、他の場所でホストされているプライベートリポジトリを認証する場合は、JSON 形式の認証方法と資格情報を使用してCOMPOSER_AUTH_JSON環境変数を設定できます。詳細については、 composer documentationの認証セクションを参照してください。

- name : Setup PHP
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
  env :
    COMPOSER_AUTH_JSON : |
      {
        "http-basic": {
          "example.org": {
            "username": "${{ secrets.EXAMPLE_ORG_USERNAME }}",
            "password": "${{ secrets.EXAMPLE_ORG_PASSWORD }}"
          }
        }
      }

インライン PHP スクリプト

ワークフローで複数行の PHP コードを実行する必要がある場合は、ファイルに保存せずに簡単に実行できます。

コードをステップの run プロパティに配置し、シェルをphp {0}として指定します。

- name : Setup PHP
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '

- name : Run PHP code
  shell : php {0}
  run : |
    <?php
    $welcome = "Hello, world";
    echo $welcome;

問題マッチャー

問題マッチャーは、ログ内のエラーと警告を識別し、強調表示してコード注釈を作成することで、GitHub Actions UI で目立つように表示するjson構成です。

PHP

このステップをsetup-phpステップの後に追加して、 PHP出力用の問題マッチャーをセットアップします。

- name : Setup problem matchers for PHP
  run : echo "::add-matcher::${{ runner.tool_cache }}/php.json"

PHPUユニット

このステップをsetup-phpステップの後に追加して、 PHPUnit出力用の問題マッチャーをセットアップします。

- name : Setup problem matchers for PHPUnit
  run : echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"

PHPStan

PHPStan は GitHub Actions でのエラー報告をサポートしているため、問題マッチャーは必要ありません。

- name : Setup PHP
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    tools : phpstan

- name : Run PHPStan
  run : phpstan analyse src

詩篇

Psalm は、出力形式githubを使用した GitHub Actions でのエラー報告をサポートしています。

- name : Setup PHP
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    tools : psalm

- name : Run Psalm
  run : psalm --output-format=github

checkstyle をサポートするツール

phpstan 、 psalm 、 php-cs-fixer 、 phpcsなどのcheckstyleレポートをサポートするツールの場合、 cs2pr使用してコードに注釈を付けることができます。
例については、cs2pr ドキュメントを参照してください。

以下はphpcsを使用した例です。

- name : Setup PHP
  uses : shivammathur/setup-php@v2
  with :
    php-version : ' 8.4 '
    tools : cs2pr, phpcs

- name : Run phpcs
  run : phpcs -q --report=checkstyle src | cs2pr

例

さまざまな PHP フレームワークおよびパッケージでのsetup-phpの使用例。

フレームワーク/パッケージ	実行します	ワークフロー
ブラックファイア	`macOS` 、 `ubuntu` 、 `windows`	ブラックファイア.yml
ブラックファイアプレイヤー	`macOS` 、 `ubuntu` 、 `windows`	blackfire-player.yml
CakePHP と`MySQL`および`Redis`	`ubuntu`	ケーキphp-mysql.yml
CakePHP と`PostgreSQL`および`Redis`	`ubuntu`	ケーキphp-postgres.yml
サービスなしの CakePHP	`macOS` 、 `ubuntu` 、 `windows`	ケーキphp.yml
コードイグナイター	`macOS` 、 `ubuntu` 、 `windows`	コードイグナイター.yml
ラミナスMVC	`macOS` 、 `ubuntu` 、 `windows`	ラミナス-mvc.yml
`MySQL`と`Redis`を使用した Laravel	`ubuntu`	laravel-mysql.yml
`PostgreSQL`と`Redis`を使用した Laravel	`ubuntu`	laravel-postgres.yml
サービスのないLaravel	`macOS` 、 `ubuntu` 、 `windows`	laravel.yml
`MySQL`と`Redis`使用した Lumen	`ubuntu`	ルーメン-mysql.yml
`PostgreSQL`と`Redis`を使用した Lumen	`ubuntu`	ルーメン-postgres.yml
サービスなしのルーメン	`macOS` 、 `ubuntu` 、 `windows`	ルーメン.yml
`MySQL`を使用した Phalcon	`ubuntu`	ファルコン-mysql.yml
Phalcon と`PostgreSQL`	`ubuntu`	ファルコン-postgres.yml
根・岩盤	`ubuntu`	岩盤.yml
ルーツ/セージ	`ubuntu`	sage.yml
スリムなフレームワーク	`macOS` 、 `ubuntu` 、 `windows`	スリムフレームワーク.yml
`MySQL`を使用した Symfony	`ubuntu`	symfony-mysql.yml
Symfony と`PostgreSQL`	`ubuntu`	symfony-postgres.yml
サービスのない Symfony	`macOS` 、 `ubuntu` 、 `windows`	symfony.yml
Yii2 スターターキット`MySQL`付き)	`ubuntu`	yii2-mysql.yml
`PostgreSQL`を使用した Yii2 スターターキット	`ubuntu`	yii2-postgres.yml

バージョン管理

setup-phpバージョンとしてv2タグを使用します。これはローリングタグであり、最新のマイナーリリースおよびパッチリリースと同期されます。 v2では、バグ修正、セキュリティパッチ、新機能、最新の PHP リリースのサポートが自動的に取得されます。
セマンティックリリースバージョンも使用できます。ワークフロー内のアクションを最新の状態に保つために、セマンティックバージョニングを備えた dependabot を使用することをお勧めします。
コミット SHA も使用できますが、アクションのリリースごとに更新するツールを設定しない限り、推奨されません。
アクションの新しいメジャーバージョンは、setup-php API、つまり入力、出力、環境フラグに重大な変更があった場合にのみタグ付けされます。
問題をデバッグするには、 verboseタグを一時的に使用できます。すべてのログが出力され、最新のリリースと同期されます。
mainブランチをバージョンとして使用することは強くお勧めできません。メジャーリリースには重大な変更があるため、ワークフローが中断される可能性があります。
v1タグまたは1.xyバージョンを使用している場合は、 v1サポートされなくなっているため、v2 に切り替える必要があります。

ライセンス

このプロジェクトのスクリプトとドキュメントは MIT ライセンスの下にあります。
このプロジェクトには複数の依存関係があります。ライセンスはそれぞれのリポジトリにあります。
setup-phpのロゴは php.net ロゴの派生作品であり、CC BY-SA 4.0 ライセンスに基づいてライセンスされています。

貢献

貢献は大歓迎です!

始める前に「寄稿者ガイド」を参照してください。
問題に直面したり、機能や改善を提案したい場合は、ここからディスカッションを開始してください。

setup-phpおよびその他の関連プロジェクトの貢献者

このプロジェクトをサポートする

プロジェクトにスターを付けて共有してください。ブログをやっている方は、 setup-phpの使用経験を共有してください。
setup-php のスポンサーについてご質問がある場合は、お問い合わせください。

多くのユーザーと組織が GitHub スポンサー経由で setup-php をサポートしています。

これらの企業は、このプロジェクトの開発を支援するために、setup-php に自社の製品とサービスを惜しみなく提供しています。

依存関係

Node.jsの依存関係
アーロンパーカー/VcRedist
mlocati/powershell-phpmanager
ppa:ondrej/php
shivammathur/キャッシュ拡張機能
シヴァンマサー/作曲家キャッシュ
shivammathur/homebrew-extensions
シヴァンマサー/homebrew-php
シヴァンマートゥール/icu-intl
シヴァンマサー/php-builder
シヴァンマサー/php-builder-windows
シヴァンマサー/php-ubuntu
シヴァンマサー/php5-ダーウィン
シヴァンマサー/php5-ubuntu

さらに読む

GitHub アクションについて
GitHub アクションの構文
その他の素晴らしいアクション

拡大する

setup php

コンテンツ

OS/プラットフォームのサポート

GitHub でホストされるランナー

自己ホスト型ランナー

PHPサポート

PHP 拡張機能のサポート

ツールのサポート

カバレッジサポート

Xデバッグ

PCOV

カバレッジを無効にする

使用法

入力

php-version (オプション)

php-version-file (オプション)

extensions (オプション)

ini-file (オプション)

ini-values (オプション)

coverage （オプション）

tools （オプション）

出力

php-version

フラグ

fail-fast (オプション)

phpts (オプション)

update （オプション）

基本的なセットアップ

マトリックスのセットアップ

夜間のビルドセットアップ

デバッグビルドセットアップ

スレッドセーフ設定

強制アップデートセットアップ

詳細なセットアップ

マルチアーチのセットアップ

セルフホスト型セットアップ

ローカルテストのセットアップ

JIT構成

キャッシュ拡張機能

キャッシュ・コンポーザーの依存関係

GitHub Composer 認証

プライベート Packagist 認証

手動作曲者認証

インライン PHP スクリプト

問題マッチャー

PHP

PHPUユニット

PHPStan

詩篇

checkstyle をサポートするツール

例

バージョン管理

ライセンス

貢献

このプロジェクトをサポートする

依存関係

さらに読む

`php-version` (オプション)

`php-version-file` (オプション)

`extensions` (オプション)

`ini-file` (オプション)

`ini-values` (オプション)

`coverage` （オプション）

`tools` （オプション）

`php-version`

`fail-fast` (オプション)

`phpts` (オプション)

`update` （オプション）