hound-search/hound

Add a Github CI check to make sure that if an asset is edited, ui/bindata.go is updated

Open

#365 创建于 2020年10月30日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)JavaScript (5,470 star) (606 fork)batch import
enhancementgood first issuehelp wanted

描述

We serve static assets from a serialized file in order to make Hound go-get-able (see #7). Confirming that UI PRs come with an update to ui/bindata.go would be helpful for future PRs.

Here's some helpful context (thanks to @kellegous for a lot of this):

  1. ui/bindata.go contains all the contents from ui/assets/* and is generated here in the Makefile.
  2. Generating ui/bindata.go as part of the install (i.e. in //go:generate) might be finicky on some systems, so sticking with manually updating it is a safer play for now.
  3. As mentioned above, Issue #7 has more context for why we use this approach.
  4. If you're curious, assets are read in from ui/bindata.go through calls to Asset in ui#serveAsset.

贡献者指南

技术栈
gogithub actions
领域
ci cddevops
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
GitHub ActionsMakefile syntaxGo basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Add a GitHub Actions workflow that runs on pull requests. It should detect changes in the `ui/assets/` directory using `git diff`. If changes are present, it must verify that `ui/bindata.go` is also updated (e.g., by checking its modification time or content hash). Refer to the Makefile target for regenerating `ui/bindata.go` (https://github.com/hound search/hound/blob/master/Makefile#L26 L29). The asset serving logic is in `ui/ui.go` (lines 109-123). No existing PRs or comments are linked, so no prior work to build upon.