如何发布一个 Composer 包

流程

参考: https://packagist.org/about#how-to-update-packages

Composer 说明

说明

• 包名在 composer.json 确定
• 版本号由仓库的发布版本确定, 必须发布第一个版本才能进行下载
• 建议使用 PSR-4

目录结构

├── CHANGES.md  
├── LICENSE  
├── README.md  
├── .gitignore  
├── composer.json  
├── sample  
└── src

CHANGES.md

更新说明

1.0.0 / 2020-11-20
----------

- 新增生成 token
- 新增网关请求

LICENSE

开源协议, 替换公司名称

MIT License

Copyright (c) 2020 XXXXXX

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

README.md

图标: https://poser.pugx.org/

• Installation
• Usage
• Example usage

composer 通用说明

### 安装
推荐使用 Composer 安装 dhccam-sdk，Composer 是 PHP 的依赖管理工具，允许您声明项目所需的依赖，然后自动将它们安装到您的项目中。

> 您可以在 [Composer 官网](https://getcomposer.org/) 上找到更多关于如何安装 Composer，配置自动加载以及用于定义依赖项的其他最佳实践等相关信息。

#### 安装步骤：

1. 打开终端。
2. 下载 Composer，执行以下命令。

```
curl -sS https://getcomposer.org/installer | php
```

3. 创建一个名为`composer.json`的文件，内容如下。

```json
{
    "require": {
        "xxxxxxxx/xxxx": "1.*"
    }
}
```

4. 使用 Composer 安装，执行以下命令。

```
php composer.phar install
```

使用该命令后会在当前目录中创建一个 vendor 文件夹，里面包含 SDK 的依赖库和一个 autoload.php 脚本，方便在项目中调用。

5. 通过 autoload.php 脚本调用 dhccam-sdk。

```php
require '/path/to/vendor/autoload.php';
```

.gitignore

忽略 IDE 部分

.vscode/
.idea/

composer.json

• 通过 composer init 生成
• 添加 php 版本要求
• 添加 psr-4

{
    "name": "xxxxxxxx/xxxx-sdk",
    "description": "PHP SDK for XXXXXX",
    "type": "library",
    "require": {
        "php": "^7.1"
    },
    "license": "MIT",
    "authors": [
        {
            "name": "iamname",
            "email": "iamname@163.com"
        }
    ],
    "prefer-stable": true,
    "autoload": {
        "psr-4": {
            "XXXXX\\Xxxxxx\\": "src/"
        }
    },
    "minimum-stability": "dev"
}

src

• 源码位置, 命名空间和 composer.json 对应上

sample

• 源码调用实例, 引用参考 require __DIR__. '/../vendor/autoload.php';

问题

1. 远程仓库位置
   建议使用 GitHub, 使用 gogs 需要修改配置 REQUIRE_SIGNIN_VIEW = true 为 false, 即允许公共包不需要账号密码即可查看, 可能存在源码泄露风险

修改配置

/home/git/gogs/custom/conf/app.ini

# 重启服务
service gogs restart

开始

步骤一 创建远程仓库

1. 登录 GitHub 新建包

   名称: XXXX
   描述: PHP SDK for XXXX
   Public
   MIT License

2. 本地克隆

git clone https://www.domain.com/git/mediway/XXXX.git

3. 工程初始化
4. 提交

步骤二 提交 packagist.org

参考: https://packagist.org/

1. 点击提交 Submit
2. 输入 GitHub 地址

自动更新

1. 登录 GitHub
2. 切换回 https://packagist.org/
3. 点击用户 -> Setting
4. connect GitHub

手动更新

• username 更换为当前登录优化
• apiToken 更换为对应的 apiToken
• repository.url 更换为对应包的地址

curl -XPOST -H'content-type:application/json' 'https://packagist.org/api/update-package?username=xxxxx&apiToken=xxxxx' -d'{"repository":{"url":"https://packagist.org/packages/mediway/xxxx"}}'