首页>PHP源码>其他类别
下载

使用所需的扩展、php.ini 配置、代码覆盖支持和各种工具（例如 GitHub Actions 中的 Composer）设置 PHP。此操作为您提供了一个跨平台界面来设置测试应用程序所需的 PHP 环境。请参阅“用法”部分和示例以了解如何使用它。

内容

  • 操作系统/平台支持
    • GitHub 托管的运行程序
    • 自托管运行器
  • PHP 支持
  • PHP 扩展支持
  • 工具支持
  • 覆盖支持
    • 调试工具
    • PCOV
    • 禁用覆盖范围
  • 用法
    • 输入
    • 输出
    • 旗帜
    • 基本设置
    • 矩阵设置
    • 每晚构建设置
    • 调试构建设置
    • 线程安全设置
    • 强制更新设置
    • 详细设置
    • 多架构设置
    • 自托管设置
    • 本地测试设置
    • 即时配置
    • 缓存扩展
    • 缓存组合器依赖项
    • GitHub Composer 身份验证
    • 私人Packagist身份验证
    • 手动作曲家身份验证
    • 内联 PHP 脚本
    • 问题匹配器
    • 示例
  • 版本控制
  • 执照
  • 贡献
  • 支持这个项目
  • 依赖关系
  • 进一步阅读

操作系统/平台支持

以下操作系统/平台上的setup-php支持GitHub-hosted和self-hosted运行器。

GitHub 托管的运行程序

虚拟环境YAML 工作流程标签预装 PHP
乌班图24.04 ubuntu-24.04 PHP 8.3
乌班图22.04 ubuntu-latest或ubuntu-22.04 PHP 8.1
乌班图20.04 ubuntu-20.04 PHP 7.4至PHP 8.3
Windows Server 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

自托管运行器

主机操作系统/虚拟环境YAML 工作流程标签
乌班图24.04 self-hosted或Linux
乌班图22.04 self-hosted或Linux
乌班图20.04 self-hosted或Linux
Debian 12 self-hosted或Linux
Debian 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 索诺玛 14.x x86_64/arm64 self-hosted或macOS
macOS 文图拉 13.x x86_64/arm64 self-hosted或macOS
  • 请参阅自托管设置以在自托管运行器上使用该操作。
  • 还尽力支持基于上述 Ubuntu 和 Debian 版本的操作系统。
  • 如果预安装了请求的 PHP 版本， setup-php会切换到该版本，否则会安装 PHP 版本。

PHP 支持

在所有受支持的操作系统/平台上，可以根据运行程序设置以下 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 扩展支持

可以使用extensions输入来设置 PHP 扩展。它接受 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后缀加上ICU版本，可以在Ubuntu工作流程中为PHP 5.6及更高版本设置特定ICU版本的扩展intl 。支持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 。
    • 所有支持的操作系统上的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
  • 除了上述工具之外，还可以通过将任何 Composer 工具或包指定为与 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
  • 如果您在工作流程中不使用composer，则可以指定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时，就会设置最新版本的blackfire cli。有关将blackfire与 GitHub Actions 结合使用的信息，请参阅官方文档。

  • 除非在工具输入中还指定了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

覆盖支持

调试工具

指定coverage: xdebug使用Xdebug并禁用PCOV 。
在所有受支持的 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 映像上默认启用，因此，如果您不在工作流程中使用它，建议禁用它，因为这将对您的 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

禁用覆盖范围

指定coverage: none以禁用Xdebug和PCOV 。

由于以下原因禁用承保范围：

  • 您在测试时不会生成覆盖率报告。
  • 您正在使用phpdbg来运行测试。
  • 您正在使用blackfire分析您的代码。
  • 您正在 JIT 模式下使用 PHP。请参阅 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' 。
  • 接受lowest设置以设置支持的最低 PHP 版本。
  • 接受highest或latest设置最新稳定的 PHP 版本。
  • 接受nightly从 PHP 主分支设置夜间构建。
  • 接受格式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 值用引号引起来，则接受带逗号的 ini 值。例如xdebug.mode="develop,coverage" 。

coverage （可选）

  • 指定您要设置的代码覆盖驱动程序。
  • 接受xdebug 、 pcov或none 。
  • 有关更多信息，请参阅覆盖范围支持。

tools （可选）

  • 指定您要设置的工具。
  • 接受 csv 格式的string 。例如： phpunit, phpcs
  • 请参阅工具支持以了解支持的工具。

输出

php-version

在 GitHub Actions 上，您可以为setup-php步骤分配一个id ，您可以使用相同的 ID 在后续步骤中获取输出。

  • 提供 semver 格式的 PHP 版本。 
- 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 。
  • false true

phpts （可选）

  • 指定设置 PHP 的线程安全构建。
  • 接受nts表示非线程安全，接受zts或ts表示线程安全。
  • 默认情况下，它设置为nts 。
  • 有关详细信息，请参阅线程安全设置。

update （可选）

  • 指定将运行器上的 PHP 更新到最新补丁版本。
  • false true
  • 默认情况下，它设置为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 上，调试符号作为pdb文件添加到 PHP 安装目录中。
  • 在 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

详细设置

调试您的工作流程

要调试任何问题，您可以使用verbose标记而不是v2 。 

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

多架构设置

在 Ubuntu GitHub Runners 上的多个架构上设置 PHP。

  • Ubuntu上多种架构上的setup-php支持PHP 5.6到PHP 8.4 。
  • 为此，您可以使用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
    • 视窗

  • 要直接在主机操作系统或虚拟机中设置运行程序，请在设置自托管运行程序之前遵循此要求指南。

  • 如果您的工作流程使用服务容器，则在 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

即时配置

在 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 。

缓存组合器依赖项

如果您的项目使用 Composer，您可以保留 Composer 的内部缓存目录。缓存的依赖项是直接加载的，而不是在安装时下载它们。缓存的文件在检查运行中可用，并将减少工作流执行时间。 

- 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 身份验证

如果您有多个工作流程设置了多个工具或具有许多 Composer 依赖项，则可能会达到 GitHub 对 Composer 的速率限制。此外，如果您仅指定主要版本或以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身份验证

如果您使用 Private Packagist 作为私有 Composer 依赖项，则可以设置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 属性中，并将 shell 指定为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;

问题匹配器

问题匹配器是json配置，可识别日志中的错误和警告，并通过突出显示它们并创建代码注释，在 GitHub Actions UI 中突出显示它们。

PHP

通过在setup-php步骤之后添加此步骤，为PHP输出设置问题匹配器。 

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

PHP单元

通过在setup-php步骤之后添加此步骤，为PHPUnit输出设置问题匹配器。 

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

PHP斯坦

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 Actions 中的错误报告，输出格式github 。 

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

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

支持 checkstyle 的工具

对于支持checkstyle报告的工具，如phpstan 、 psalm 、 php-cs-fixer和phpcs您可以使用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

示例

将setup-php与各种 PHP 框架和包一起使用的示例。

框架/包运行于工作流程
黑火macOS 、 ubuntu和windows黑火.yml
黑火玩家macOS 、 ubuntu和windows blackfire-player.yml
CakePHP 与MySQL和Redis ubuntu cakephp-mysql.yml
CakePHP 与PostgreSQL和Redis ubuntu cakephp-postgres.yml
没有服务的 CakePHP macOS 、 ubuntu和windows cakephp.yml
代码点火器macOS 、 ubuntu和windows代码点火器.yml
层状MVC macOS 、 ubuntu和windows层流-mvc.yml
Laravel 与MySQL和Redis ubuntu laravel-mysql.yml
Laravel 与PostgreSQL和Redis ubuntu laravel-postgres.yml
没有服务的 Laravel macOS 、 ubuntu和windows laravel.yml
Lumen 与MySQL和Redis ubuntu lumen-mysql.yml
Lumen 与PostgreSQL和Redis ubuntu流明-postgres.yml
无服务的流明macOS 、 ubuntu和windows流明.yml
Phalcon 与MySQL ubuntu phalcon-mysql.yml
Phalcon 与PostgreSQL ubuntu phalcon-postgres.yml
根/基岩ubuntu基岩.yml
根/圣人ubuntu圣人.yml
纤薄的框架macOS 、 ubuntu和windows slim-framework.yml
Symfony 与MySQL ubuntu symfony-mysql.yml
Symfony 与PostgreSQL ubuntu symfony-postgres.yml
没有服务的 Symfony macOS 、 ubuntu和windows symfony.yml
带MySQL的 Yii2 入门套件ubuntu yii2-mysql.yml
Yii2 入门套件与PostgreSQL ubuntu yii2-postgres.yml

版本控制

  • 使用v2标签作为setup-php版本。它是一个滚动标签，并与最新的次要版本和补丁版本同步。使用v2您可以自动获得错误修复、安全补丁、新功能以及对最新 PHP 版本的支持。
  • 也可以使用语义发布版本。建议使用具有语义版本控制的 dependentabot 以使工作流程中的操作保持最新。
  • 也可以使用提交 SHA，但不建议使用，除非您设置工具以在每次发布操作时更新它们。
  • 仅当 setup-php API（即输入、输出和环境标志）发生重大更改时，才会标记该操作的新主要版本。
  • 为了调试任何问题，可以暂时使用verbose标签。它输出所有日志并与最新版本同步。
  • 强烈建议不要使用main分支作为版本，这可能会在主要版本发布后破坏您的工作流程，因为它们具有重大更改。
  • 如果您使用v1标签或1.xy版本，您应该切换到 v2，因为v1不再受支持。

执照

  • 该项目中的脚本和文档均遵循 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/作曲家缓存
  • Shivammathur/自制扩展
  • shivammathur/homebrew-php
  • 希瓦马图尔/国际重症监护室
  • Shivammathur/php-builder
  • shivammathur/php-builder-windows
  • Shivammathur/php-ubuntu
  • 希瓦马图尔/php5-达尔文
  • Shivammathur/php5-ubuntu

进一步阅读

  • 关于 GitHub 操作
  • GitHub 操作语法
  • 其他很棒的动作
展开
附加信息
相关应用
为您推荐
相关资讯 全部