教你发布自己的composer包「步骤详解」

1. 准备工作

在你将代码上传到 Packagist 之前,你需要做以下准备工作:

下载 Composer

Github 上创建一个新的仓库,并通过 git clone 将代码仓库克隆到本地。

2. 编写代码

开始编写你的代码。注意它必须按照 Packagist 的要求 进行组织,并需要添加一个 composer.json 文件来描述你的包。

2.1 组织代码

为了确保你的包能够在 Packagist 上顺利工作,你应该遵守以下的目录结构:

/

├── src/

├── YourName/

├── YourPackage/

├── YourClass.php

├── tests/

├── YourName/

├── YourPackage/

├── YourTest.php

├── composer.json

└── README.md

提示: 记得将 YourName 替换成你的Github用户名,将 YourPackage 替换成你的包名。

2.2 编写composer.json文件

在你的项目根目录中,创建一个叫做 composer.json 的文件。然后将下面的代码复制到文件中:

{

"name": "your-name/your-package",

"description": "Your Package Description",

"keywords": ["keywords", "separated", "by", "comma"],

"license": "MIT",

"authors": [

{

"name": "Your Name",

"email": "youremail@example.com"

}

],

"autoload": {

"psr-4": {

"YourName\\YourPackage\\": "src/"

}

},

"require": {

"php": "^7.2"

},

"require-dev": {

"phpunit/phpunit": "^8.0"

}

}

注意事项: 使用正确的 name 格式,推荐使用 “vendor/package” 的命名方式。

3. 将包提交到Github

在本地使用Git将代码提交到Github上,执行以下命令:

git add .

git commit -m "Initial commit"

git remote add origin https://github.com/your-username/your-package.git

git push -u origin master

说明: 在 git remote add 命令中,你需要使用自己的Github用户名和仓库名替换链接中的 your-usernameyour-package

4. 注册包

访问 Packagist 的官网,点击右上角的“Submit”按钮,进入提交包界面:

将你的Github链接粘贴到“Repository URL”栏目中。

点击“Check”按钮,确认您的仓库已通过验证。

确认您的包名称、“Description”、“Keywords”和“Author”信息。

点击“Submit”按钮以注册您的包。

注意事项: 注册成功后,可以到packagist.org的自己的个人页面查看上传的包信息。

5. 要求自己的composer包

在你的项目中,需要通过 composer require your-name/your-package 命令来要求你的包。

说明: 为确保你的包能够顺利工作,你需要在命令行进入你项目的目录,然后输入上面的命令。

6. 发布更新

如果你需要发布更新,你也需要进行以下步骤:

在你的代码仓库里进行更改。

提交你的代码更新到Github上。

增加版本号。

获取你的包。

推送更新到Packagist上。

参考代码:可以参考我的Arrss项目,更好的理解composer包。