Document the process of building assets for addons
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
调研方向
Start by locating the addon development documentation and checking how it currently explains frontend assets and release workflows. Document the two approaches in the issue: committing built assets and publishing them, or building assets in GitHub Actions and distributing them with a Composer update. The work is done when addon developers can follow the documentation to choose and use either approach.
由索引模型根据 Issue 内容生成。
描述
This question has just come up on Discord:
Does anyone have any tips on how to distribute assets for an addon? I am developing an addon that needs some js and css on the frontend to work, I created frontend assets using vite but when used with the vite tag they only work for npm run build not dev
My response was:
You can either:
- Build them manually before you tag a release and include them in the Git repository. Then, in your service provider, you can publish the files to the site's
public/vendordirectory.- A little more advanced way (which we do at Statamic, and I use for my addons), is to ignore committing assets to the repository, then building them as part of a GitHub Actions workflow used for releasing. Jason's built a package which'll then copy over the assets from the GitHub release into the site's
vendordirectory uponcomposer update.
It feels like we could do with some more detailed documentation around how addon developers should handle this.
- 主要语言
- PHP
- 星标
- 133
- 派生
- 405
- 平均合并
- 21 小时 45 分钟
- 30 天内合并 PR
- 12
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
statamic/docs 的其他 Issue
-
难度 1/5 1 小时以内 新手友好度 75/100
维护者通常 1 天内回复
-
Chunked Uploads未关闭
难度 1/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
Installation / Deployment Guides
难度 2/5 1-3 小时 新手友好度 65/100
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 40/100
维护者通常 1 天内回复
-
Document how conditions treat empty and null values可能已有人在做 @joshdaugherty 于 15 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 25/100
维护者通常 1 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 62/100
TYPO3BestPractices/tea#2409 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
api-platform/core#8690 ·
维护者通常 1 天内回复
-
No Code Attached Yet
难度 2/5 1-3 小时 新手友好度 72/100
joomla/joomla-cms#48626 ·
维护者通常 1 天内回复
-
enhancement good first issue
难度 2/5 1-3 小时 新手友好度 70/100
DorsetDigital/silverstripe-schema-manager#26 ·
维护者通常 1 天内回复
-
sync-en
难度 1/5 1-3 小时 新手友好度 68/100
维护者通常 4 天内回复