phing/phing

PHing 不是 GNU make;它是一个基于 Apache Ant 的 PHP 项目构建系统或构建工具。

资助包维护!
Patreon
mrook
siad007

安装 17,901,576

依赖项 1,062

建议者: 17

安全: 0

星星 1,157

关注者: 57

分支: 320

开放问题: 11

3.0.0 2024-05-01 18:28 UTC

README

Phing CI Scrutinizer Code Quality codecov

感谢您使用 PHING!

PHing INot GNU make;它是一个基于 Apache Ant 的 PHP 项目构建系统或构建工具。您可以用它做任何您可以用传统构建系统(如 GNU make)做的事情,它使用简单的 XML 构建文件和可扩展的 PHP "任务" 类,使其成为一个易于使用且高度灵活的构建框架。

功能包括运行 PHPUnit 单元测试(包括测试结果和覆盖率报告)、文件转换(例如令牌替换、XSLT 转换、模板转换)、文件系统操作、交互式构建支持、SQL 执行、SCM 操作(Git、Subversion 和 Mercurial)、文档生成(PhpDocumentor、ApiGen)等。

如果您发现自己正在编写自定义脚本来处理应用程序的打包、部署或测试,那么我们建议查看 Phing。Phing 预装了大量的开箱即用操作模块(任务),并且提供了一个易于使用的面向对象模型来扩展或添加您自己的自定义任务。

有关更多信息文档,您可以访问我们的官方网站 https://www.phing.info/

Phing 3

Phing 3 是一个重大更新,与 Phing 2 相比有一些破坏性更改。有关详细信息,请参阅 UPGRADING.md 文件。

支持的 PHP 版本

Phing 3.x 与 PHP 7.4 及更高版本兼容。

安装

  1. Composer

安装 Phing 的首选方法是使用 Composer。将 phing/phing 添加到项目配置文件 composer.json 中的 require-dev 或 require 部分,然后运行 'composer install'。

     {
         "require-dev": {
             "phing/phing": "3.0.x-dev"
         }
     }
  1. Phar

下载 Phar 存档。然后可以通过运行以下命令执行存档:

     $ php phing-latest.phar
  1. Docker(实验性)

官方 Phing Docker 镜像可以在 Docker Hub 上找到。

要在容器内执行 Phing 并执行位于 /home/userbuild.xml,请运行以下命令:

     $ docker run --rm -v /home/user:/opt phing/phing:3.0 -f /opt/build.xml
  1. Phing GitHub Action

官方 GitHub action phingofficial/phing-github-action 可在 GitHub Marketplace 上找到。

要将 运行 Phing 构建 作为操作,您需要设置 .github/workflow/phing.yml 工作流程文件,并粘贴以下片段

 name: CI
 on: [ push ]
 jobs:
   build-test:
     runs-on: ubuntu-latest

     steps:
       - uses: actions/checkout@v2
       - name: Phing Build
         uses: phingofficial/phing-github-action@v2.0.0
         with:
           version: 3.0.0-alpha4
           user-properties: prop=FooBar
           targets: foo
           verbose: true

README 了解更多信息文档。

文档

Phing 的文档可在 https://www.phing.info/#docs 找到。

有关文档来源,请访问https://github.com/phingofficial/guide

联系方式

捐赠

多年来,开发和维护Phing花费了很多时间。如果您想表示感激,可以使用以下方法之一向项目维护者Michiel Rook捐赠

谢谢!

帮助我们识别和修复错误

当用户报告问题或提出功能请求时,我们非常感激。然而,在提交新问题之前,您应遵守以下几项指南

  • 确保问题尚未提交,请通过搜索(已关闭)问题列表来确认。
  • 支持和安装问题应在Twitter、Slack或IRC上提出,而不是作为问题提交。
  • 给出问题的良好描述,这包括重现问题的必要步骤!
  • 如果您有解决方案,请告诉我们!这不必是代码。我们感谢任何可以帮助我们解决问题的代码片段、想法、创意等。

问题可以在GitHub上报告。

拉取请求

将代码提交给Phing的最佳方式是在GitHub上创建拉取请求。请帮助我们快速合并您的贡献,并确保您的拉取请求简洁明了:压缩提交,不要引入不必要的(空白)更改。

Phing的源代码格式遵循PSR-2标准。

运行(单元)测试

如果您想为Phing贡献代码,请在提交拉取请求之前确保运行测试。要成功运行所有Phing测试,必须满足以下条件

  • 已安装PEAR,已发现通道“pear.phing.info”
  • 已安装“python-docutils”和“subversion”软件包
  • 将php.ini设置“phar.readonly”设置为“关闭”

然后,执行以下步骤(在Phing的克隆/分支上)

     $ composer install
     $ cd tests
     $ ../bin/phing

许可协议

本软件的许可条款可在本目录中名为“LICENSE”的文件中找到。

自豪地使用

PhpStorm Logo

贡献

我们热爱贡献!

感谢所有已经做出贡献的人们!