hound-search/hound

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

Open

#365 opened on 2020年10月30日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)JavaScript (5,470 stars) (606 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.
Add a Github CI check to make sure that if an asset is edited, ui/bindata.go is updated · hound-search/hound#365 | Good First Issue