Skip to content

Commit eaa56da

Browse files
author
Seio
committed
docs: add 16MB size limit note for plugin publishing
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.
1 parent bbda1e6 commit eaa56da

2 files changed

Lines changed: 22 additions & 0 deletions

File tree

docs/en/dev/star/plugin-publish.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,14 @@ AstrBot uses GitHub to host plugins, so you'll need to push your plugin code to
77
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.
88

99
![fill out the form](https://files.astrbot.app/docs/source/images/plugin-publish/image.png)
10+
11+
> ⚠️ **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.
12+
>
13+
> To ensure your plugin passes review and publication smoothly, we recommend the following:
14+
>
15+
> - **Compress static assets**: Compress images, audio, and other resource files in your plugin to reduce their size.
16+
> - **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.
17+
> - **Optimize dependency size**: If your plugin depends on large libraries, consider trimming them down or importing only what is needed.
18+
> - **Use `.gitattributes` or a release branch**: Reduce the zip package size by including only the files necessary for distribution.
19+
>
20+
> If your plugin truly cannot be compressed to under 16MB due to business requirements, please contact the maintainer to manually bypass this limit.

docs/zh/dev/star/plugin-publish.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,14 @@ AstrBot 使用 GitHub 托管插件,因此你需要先将插件代码推送到
77
你可以前往 [AstrBot 插件市场](https://plugins.astrbot.app) 提交你的插件。进入该网站后,点击右下角的 `+` 按钮,填写好基本信息、作者信息、仓库信息等内容后,点击 `提交到 GTIHUB` 按钮,你将会被导航到 AstrBot 仓库的 Issue 提交页面,请确认信息无误后点击 `Create` 按钮提交,即可完成插件发布。
88

99
![fill out the form](https://files.astrbot.app/docs/source/images/plugin-publish/image.png)
10+
11+
> ⚠️ **大小限制**:发布到插件市场的插件压缩包(zip)大小**不得超过 16MB**。如果超过此限制,CI/CD 流水线将自动拒绝该发布请求。
12+
>
13+
> 为确保你的插件能顺利通过审核和发布,建议采取以下措施:
14+
>
15+
> - **压缩图片等静态资源**:对插件中的图片、音频等资源文件进行压缩,减小体积。
16+
> - **清理不必要的文件**:避免将 `.git` 目录、`__pycache__``node_modules`、开发用配置文件等非必需文件提交到插件仓库中。建议在仓库根目录添加 `.gitignore` 来排除它们。
17+
> - **优化依赖体积**:如果插件包含体积较大的依赖库,可考虑精简或按需引入。
18+
> - **使用 `.gitattributes` 或发布分支**:通过只包含发布所需文件的策略来减小 zip 包体积。
19+
>
20+
> 如果插件确实因业务需要无法压缩到 16MB 以内,可以联系维护者手动 bypass 此限制。

0 commit comments

Comments
 (0)