首先创建项目并初始化composer.json,接着按PSR-4规范编写src代码与tests测试,配置.gitignore后提交至Git,打v1.0.0标签并推送到GitHub,然后在Packagist提交仓库URL发布包,最后通过GitHub webhook实现自动同步更新。
如果您希望将一段PHP代码封装成可复用的组件,并让其他开发者通过Composer轻松引入,那么您需要创建并发布一个Composer包。以下是完成此目标的具体流程。
本文运行环境:MacBook Pro,macOS Sonoma
一、初始化项目结构
在开始之前,需要为您的包建立清晰的目录结构,这有助于维护和被他人理解。通常包含src目录存放源码,tests目录存放测试文件,以及必要的配置文件。
1、创建一个新的项目文件夹,例如 my-awesome-package 并进入该目录。
2、执行命令 composer init 来交互式地生成 composer.json 文件,填写名称、描述、作者、自动加载规则等信息。
3、按照 PSR-4 规范设置 autoload 字段,例如将命名空间 MyAwesomePackage 映射到 src/ 目录下。
二、编写功能代码与单元测试
一个高质量的包应当具备明确的功能实现和对应的测试用例,以保证稳定性和可靠性。
1、在 src/ 目录中创建主类文件,如 AwesomeClass.php,并实现具体逻辑。
2、在 tests/ 目录中使用 PHPUnit 编写测试用例,验证核心方法的行为是否符合预期。
3、在 composer.json 的 require-dev 中添加 phpunit/phpunit 依赖,并配置 scripts 来运行测试命令。
三、配置版本控制与.gitignore
使用 Git 管理代码变更历史是发布包的前提条件之一,同时应排除不必要的文件上传。
1、运行 git init 初始化本地仓库,并提交所有必要文件。
2、创建 .gitignore 文件,排除 vendor/、composer.lock、.env 等非必需纳入版本控制的内容。
3、提交初始版本:执行 git add . 和 git commit -m “Initial commit”。
四、打标签并推送到远程仓库
Packagist 会根据 Git 标签识别版本号,因此必须为发布的每个稳定版本打上语义化版本标签。
1、执行 git tag -a v1.0.0 -m “Release version 1.0.0” 创建一个带注释的标签。
2、将代码及标签推送到 GitHub 或 GitLab 等公开平台:git push origin main –tags。
3、确保远程仓库为公开可访问状态,以便 Packagist 能够抓取元数据。
五、注册并发布到Packagist
Packagist 是 Composer 的默认包仓库,将您的包提交至此即可让全球用户通过 composer require 安装。
1、访问 https://packagist.org 并使用 GitHub 账户登录。
2、点击右上角 “Submit” 按钮,输入您的 GitHub 仓库 URL(如 https://github.com/username/my-awesome-package)。
3、点击检查,确认无误后提交。Packagist 将自动获取 composer.json 中的信息并创建包页面。
六、启用自动同步更新
每次推送新标签或代码更改时,手动刷新 Packagist 并不高效,可通过 webhook 实现自动化。
1、在 GitHub 仓库中进入 Settings > Webhooks > Add webhook。
2、Payload URL 填写 https://packagist.org/api/github?username=YOUR_PACKAGIST_USERNAME&apiToken=YOUR_API_TOKEN。
3、设置触发事件为 “Just the push event”,保存后即可实现推送即更新。
以上就是php js git json composer github macbook mac ai macos gitlab php composer json 命名空间 封装 require Event 并发 事件 github git macos gitlab https 自动化