hound-search/hound

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

Open

#365 aberto em 30 de out. de 2020

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (5.470 stars) (606 forks)batch import
enhancementgood first issuehelp wanted

Description

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.

Guia do colaborador

Pilha de tecnologia
gogithub actions
Domain
ci cddevops
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
GitHub ActionsMakefile syntaxGo basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70
Direção de pesquisa
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.