From 224915fbc883698ce8f9d979054e2cf5f9f43468 Mon Sep 17 00:00:00 2001 From: AstrBot Date: Sat, 9 May 2026 22:00:15 +0800 Subject: [PATCH] docs: add 16MB size limit note for plugin publishing (#8108) Add documentation to clarify the 16MB zip size limit for plugin marketplace submissions, along with practical recommendations: - Compress static assets like images - Clean up unnecessary files (.git, __pycache__, etc.) - Optimize dependency sizes - Use .gitattributes or release branches Also mention the option to contact maintainers for manual bypass when the limit cannot be met. Co-authored-by: Seio --- docs/en/dev/star/plugin-publish.md | 11 +++++++++++ docs/zh/dev/star/plugin-publish.md | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/docs/en/dev/star/plugin-publish.md b/docs/en/dev/star/plugin-publish.md index 29864fd32..4bb2a68e9 100644 --- a/docs/en/dev/star/plugin-publish.md +++ b/docs/en/dev/star/plugin-publish.md @@ -7,3 +7,14 @@ AstrBot uses GitHub to host plugins, so you'll need to push your plugin code to You can submit your plugin by visiting the [AstrBot Plugin Marketplace](https://plugins.astrbot.app). Once on the website, click the `+` button in the bottom-right corner, fill in the basic information, author details, repository information, and other required fields. Then click the `Submit to GITHUB` button. You will be redirected to the AstrBot repository's Issue submission page. Please verify that all information is correct, then click the `Create` button to complete the plugin publication process. ![fill out the form](https://files.astrbot.app/docs/source/images/plugin-publish/image.png) + +> ⚠️ **Size Limit**: The plugin zip package submitted to the marketplace **must not exceed 16MB**. If it exceeds this limit, the CI/CD pipeline will automatically reject the submission. +> +> To ensure your plugin passes review and publication smoothly, we recommend the following: +> +> - **Compress static assets**: Compress images, audio, and other resource files in your plugin to reduce their size. +> - **Clean up unnecessary files**: Avoid including directories like `.git`, `__pycache__`, `node_modules`, or development configuration files in your plugin repository. Add a `.gitignore` file to your repository root to exclude them. +> - **Optimize dependency size**: If your plugin depends on large libraries, consider trimming them down or importing only what is needed. +> - **Use `.gitattributes` or a release branch**: Reduce the zip package size by including only the files necessary for distribution. +> +> If your plugin truly cannot be compressed to under 16MB due to business requirements, please contact the maintainer to manually bypass this limit. diff --git a/docs/zh/dev/star/plugin-publish.md b/docs/zh/dev/star/plugin-publish.md index 45997acc5..57f2f0a38 100644 --- a/docs/zh/dev/star/plugin-publish.md +++ b/docs/zh/dev/star/plugin-publish.md @@ -7,3 +7,14 @@ AstrBot 使用 GitHub 托管插件，因此你需要先将插件代码推送到 你可以前往 [AstrBot 插件市场](https://plugins.astrbot.app) 提交你的插件。进入该网站后，点击右下角的 `+` 按钮，填写好基本信息、作者信息、仓库信息等内容后，点击 `提交到 GITHUB` 按钮，你将会被导航到 AstrBot 仓库的 Issue 提交页面，请确认信息无误后点击 `Create` 按钮提交，即可完成插件发布。 ![fill out the form](https://files.astrbot.app/docs/source/images/plugin-publish/image.png) + +> ⚠️ **大小限制**：发布到插件市场的插件压缩包（zip）大小**不得超过 16MB**。如果超过此限制，CI/CD 流水线将自动拒绝该发布请求。 +> +> 为确保你的插件能顺利通过审核和发布，建议采取以下措施： +> +> - **压缩图片等静态资源**：对插件中的图片、音频等资源文件进行压缩，减小体积。 +> - **清理不必要的文件**：避免将 `.git` 目录、`__pycache__`、`node_modules`、开发用配置文件等非必需文件提交到插件仓库中。建议在仓库根目录添加 `.gitignore` 来排除它们。 +> - **优化依赖体积**：如果插件包含体积较大的依赖库，可考虑精简或按需引入。 +> - **使用 `.gitattributes` 或发布分支**：通过只包含发布所需文件的策略来减小 zip 包体积。 +> +> 如果插件确实因业务需要无法压缩到 16MB 以内，可以联系维护者手动 bypass 此限制。