发布插件

🚀 发布插件

分享你的作品，让更多人使用

发布前准备

检查清单

在发布插件之前，请确保以下事项已完成：

功能完整：核心功能已实现并通过测试
代码规范：遵循开发规范，代码整洁
文档完善：包含 README.md 说明文档
配置正确：plugin.json 信息完整
无敏感信息：未包含密码、API Key 等敏感数据
兼容性测试：在不同环境测试通过

文件整理

确保插件目录结构完整：

my_plugin/
├── App.php              # 主类文件
├── index.html           # 插件页面
├── plugin.json          # 插件配置
├── config.html          # 配置页面（可选）
├── README.md            # 说明文档
└── static/              # 静态资源
    ├── css/
    ├── js/
    └── images/

编写 README

README 模板

# 插件名称

[![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)]()
[![License](https://img.shields.io/badge/license-MIT-green.svg)]()

> 插件的简短描述，一句话说明核心功能

## 功能特性

- ✨ 特性 1：详细说明
- 🚀 特性 2：详细说明
- 🎨 特性 3：详细说明

## 安装方法

### 方法一：手动安装

1. 下载插件压缩包
2. 解压到 `plugin/{分类}/` 目录
3. 在后台启用插件

### 方法二：命令行安装

```bash
cd plugin/{分类}
wget https://github.com/username/repo/releases/download/v1.0.0/my_plugin.zip
unzip my_plugin.zip

使用方法

基本使用

进入插件页面
输入需要处理的数据
点击处理按钮
查看结果

配置说明

如果插件支持配置，说明配置项：

配置项	说明	默认值
api_key	API 密钥	无
timeout	超时时间	30

截图展示

💡 在这里插入插件截图，展示插件界面和功能

建议包含：

插件主界面截图

功能演示截图

配置界面截图

更新日志

v1.0.0 (2024-02-10)

✨ 初始版本发布
🚀 实现核心功能
🐛 修复已知问题

v0.9.0 (2024-02-01)

🧪 Beta 测试版本

技术栈

PHP 7.4+
ThinkPHP 6
Layui
Vue.js（可选）

开发计划

功能 1
功能 2
功能 3

贡献指南

欢迎提交 Issue 和 Pull Request！

许可证

MIT © 作者名

## 打包插件

### 手动打包

```bash
# 进入插件目录
cd plugin/dev/my_plugin

# 创建压缩包（排除不必要的文件）
zip -r my_plugin_v1.0.0.zip . \
  -x "*.git*" \
  -x "*.DS_Store" \
  -x "*.log" \
  -x "*.md" \
  -x "screenshots/*"

# 查看压缩包内容
unzip -l my_plugin_v1.0.0.zip

打包脚本

创建 build.sh：

#!/bin/bash

# 插件名称
PLUGIN_NAME="my_plugin"
VERSION="1.0.0"
CATEGORY="dev"

# 进入插件目录
cd "plugin/${CATEGORY}/${PLUGIN_NAME}"

# 清理旧文件
rm -f "${PLUGIN_NAME}_v${VERSION}.zip"

# 创建压缩包
zip -r "${PLUGIN_NAME}_v${VERSION}.zip" . \
  -x "*.git*" \
  -x "*.DS_Store" \
  -x "*.log" \
  -x "screenshots/*" \
  -x "tests/*" \
  -x ".idea/*" \
  -x ".vscode/*"

echo "打包完成: ${PLUGIN_NAME}_v${VERSION}.zip"

使用：

chmod +x build.sh
./build.sh

版本管理

语义化版本

使用 SemVer 规范：

版本格式：主版本号.次版本号.修订号

1.0.0
│ │ │
│ │ └── 修订号：Bug 修复
│ └──── 次版本号：功能新增（向下兼容）
└────── 主版本号：重大更新（可能不兼容）

版本发布流程

更新版本号

{
    "name": "我的插件",
    "version": "1.1.0",
    "description": "新增某某功能"
}

更新日志

## 更新日志

### v1.1.0 (2024-02-15)

- ✨ 新增功能 A
- 🚀 优化功能 B 的性能
- 🐛 修复问题 C

创建 Git 标签

git add .
git commit -m "release: v1.1.0"
git tag -a v1.1.0 -m "版本 1.1.0"
git push origin v1.1.0

创建 Release
- 在 GitHub 上创建 Release
- 上传打包好的 zip 文件
- 填写更新说明

发布到 GitHub

创建仓库

登录 GitHub
点击 “New Repository”
填写仓库信息：
- Repository name: toolbox-plugin-{插件名}
- Description: Toolbox 插件 - {插件功能描述}
- Public/Private: 选择 Public
- Add README: 勾选

上传代码

# 初始化仓库
git init

# 添加远程仓库
git remote add origin https://github.com/username/toolbox-plugin-my-plugin.git

# 添加文件
git add .

# 提交
git commit -m "initial commit"

# 推送
git push -u origin main

创建 Release

进入仓库页面
点击右侧 “Releases”
点击 “Create a new release”
填写信息：
- Choose a tag: 创建新标签（如 v1.0.0）
- Release title: v1.0.0
- Describe this release: 填写更新日志
上传打包好的 zip 文件
点击 “Publish release”

分享给社区

分享渠道

GitHub
- 创建完整的仓库
- 编写详细的 README
- 发布 Release
技术论坛
- V2EX
- 掘金
- CSDN
- 博客园
社交媒体
- 微信公众号
- 知乎
- Twitter
- 个人博客
Toolbox 社区
- 在 Toolbox GitHub 提交 Issue 分享
- 加入 Toolbox 用户群

分享模板

## 🎉 我开发了一个新的 Toolbox 插件！

### 插件名称
{插件名称}

### 功能介绍
{一句话描述插件功能}

### 主要特性
- ✨ 特性 1
- 🚀 特性 2
- 🎨 特性 3

### 安装方法
1. 下载：https://github.com/username/repo/releases
2. 解压到 plugin/{分类}/ 目录
3. 后台启用插件

### 截图
[插入截图]

### 开源地址
https://github.com/username/toolbox-plugin-{插件名}

维护更新

收集反馈

关注 GitHub Issues
回复用户评论
记录功能建议

Bug 修复

复现问题
定位原因
修复代码
测试验证
发布更新

功能迭代

评估需求
规划设计
开发实现
测试验证
发布更新

版本兼容性

保持向后兼容
重大更新时说明迁移方法
提供升级脚本（如有必要）

最佳实践

✅ 推荐做法

文档先行
- 编写清晰的 README
- 提供使用示例
- 记录更新日志
版本管理
- 使用语义化版本
- 创建 Git 标签
- 发布 Release
社区互动
- 及时回复 Issue
- 接受 Pull Request
- 感谢贡献者
持续维护
- 定期更新
- 修复 Bug
- 跟进依赖更新

❌ 避免做法

发布不完整版本
- 功能未测试
- 缺少文档
- 包含敏感信息
忽视用户反馈
- 不回复 Issue
- 不修复已知 Bug
- 长期不更新
版本混乱
- 随意更改版本号
- 不记录更新内容
- 破坏性更新无说明

🚀 插件发布成功！

感谢你的贡献，让 Toolbox 生态更加丰富多彩～