Setup Github Actions CI #354

blobbered · 2020-10-15T23:31:30Z

This PR is one of several smaller ones made from this original PR, by klingtnet.

Original description:

Replaces Travis CI with Github Actions for better integration.
Jobs are run against more recent Go versions, namely 1.12 to 1.14 .
 .
For further documentation see

- https://github.com/actions/setup-go
- and https://help.github.com/en/actions

This adds `-race` flag to the Go tests and will run a meta linter
(golangci-lint).

Replaces Travis CI with Github Actions for better integration. Jobs are run against more recent Go versions, namely 1.12 to 1.14 . . For further documentation see - https://github.com/actions/setup-go - and https://help.github.com/en/actions This adds `-race` flag to the Go tests and will run a meta linter (golangci-lint).

salemhilal · 2020-10-26T00:59:16Z

README.md

@@ -1,6 +1,6 @@
 # Hound

-[![Build Status](https://travis-ci.org/hound-search/hound.svg?branch=master)](https://travis-ci.org/hound-search/hound) 
+![.github/workflows/go.yaml](https://github.com/spreadshirt/hound/workflows/.github/workflows/go.yaml/badge.svg)


I think this isn't quite the right URL for our badge. This points to the badge that lives in a forked copy of Hound.

salemhilal

For now, can you remove the deletion of the travis.yml, and the updated badge? I want to make sure tests work as expected with github workflows before tearing travis out (for example, I don't totally know how this would work with go v1.12, since we use go modules).

salemhilal · 2020-10-30T19:00:42Z

Sorry for the long back-and-forth on this one. It looks like most of the tests are failing as-written. You can see them in your fork under the "Actions" tab. Here's the most recent job:
https://github.com/blobbered/hound/actions/runs/329382320/workflow

Based on this issue, I think these problems are because the repo isn't a go module in your branch:
https://stackoverflow.com/questions/62945517/github-action-golang-cannot-find-package

The commit to add go module support to Hound has been merged (thank you for that!), so I think updating this branch should fix the problem. If the branch is up to date and the build is passing, I'll be down to merge this in.

…tions-ci

blobbered · 2020-11-05T17:18:19Z

You're right! A merge helped and I've tidied the mods file.

As a side note- commit e910b07 removes the lint command, since the code is not yet linted and the command was failing. I intend to revert it in the vacuum lint PR so that we can keep these PRs relatively separate, assuming that this PR comes first and then the linter PR comes next.

salemhilal · 2020-11-06T00:30:37Z

I see a passing test in the actions tab in your fork! I noticed you removed go-bindata from go.mod, but we do in fact use that library. If you put it back in, I think I can merge this PR.

blobbered · 2020-11-09T16:29:05Z

ah, okay! will do

salemhilal · 2020-11-10T02:20:13Z

go.sum

 github.com/blang/semver v3.5.1+incompatible h1:cQNTCjp13qL8KC3Nbxr/y2Bqb63oX6wdnnjpJbkM4JQ=
 github.com/blang/semver v3.5.1+incompatible/go.mod h1:kRBLl5iJ+tD4TcOOxsy/0fnwebNt5EWlYSAyrTnjyyk=
-github.com/go-bindata/go-bindata v1.0.0 h1:DZ34txDXWn1DyWa+vQf7V9ANc2ILTtrEjtlsdJRF26M=
-github.com/go-bindata/go-bindata v3.1.2+incompatible h1:5vjJMVhowQdPzjE1LdxyFF7YFTXg5IgGVW4gBr5IbvE=
-github.com/go-bindata/go-bindata v3.1.2+incompatible/go.mod h1:xK8Dsgwmeed+BBsSy2XTopBn/8uK2HWuGSnA11C3Joo=


Sorry for all the back-and-forth: can you revert the changes to this file as well?

yeah! out of curiousity, how come go-bindata is an implicit dependency?

I don't have a great answer because I'm still relatively new to go modules, but I believe it's because go-bindata is only used in the Makefile and not directly in any go source files.

salemhilal · 2020-11-11T01:46:15Z

Nice! It looks like this config is working so I'm going to merge this in. Thanks for all your patience with me and all these back-and-forths.

@blobbered

* Update config-example.json * Add CONTRIBUTING.md file * Dockerfile should use github.com/hound-search This fixing the docker build issue. * make listen URL clickable in iTerm (hound-search#340) * Add Jest tests and Prettier support (hound-search#343) This commit adds support for Jest and writes a few simple tests as proof. Adding a test is as easy as adding a file that ends in `.test.js` next to the file you want to test. Any file that matches that pattern should have access to Jest functions. The whole test suite can be run with `npm run test`. I also added support for Prettier. Running `npm run format` should run Prettier on any staged changes. I thought about adding Husky to automatically run Prettier as a pre-commit hook, but it seems as though Husky requires git v2.13 which would require me upgrading Git. I didn't add support for ESLint yet since I figured that may be a slightly more involved conversation — Prettier seems to be generally uncontroverical and is generally only slightly configurable, whereas ESlint is highly configurable and behaves however we want it to. * Git VCS driver: Support non-default target refs (hound-search#345) Currently, only the default ref (`master`) is supported. - Allow target non-default target refs to be specified via configs. - Add config-driven target ref auto-detection using the `HEAD` branch. - Update default repo base URL pattern to link to the content revision, accounting for potential non-default target ref usage. - Add global-level VCS configs which are merged into the repo-level configs during startup (repo-level vals take precedence). * Exclude file path (hound-search#347) * index: add a search option to exclude files given a regexp * api: add the excludeFiles query parameter Set the index search options ExcludeFileRegexp with this parameter to allow excluding files from the search via a regexp. * js: add the excludeFiles search parameter * css: increase the label width to fit 'Exclude file path' * js: correctly check that advanced is empty * Update README with contact info for maintainers. (hound-search#348) I don't think there's a clear way to see who has push privs to this repo from the public, and even if there is, the "Get In Touch" section should probably list the maintainers. * incorporate detailing around gopath in README's quick start instructions (hound-search#352) Co-authored-by: Rebecca Lau <[email protected]> * pin alpine version to make the docker pass * Update Dockerfile * More detailed setup documents with less assumptions on users (hound-search#359) This commit updates the readme to be a little more verbose for people who don't necessarily have Go or Docker set up, but who want to contribute nonetheless. * Apply the old patch * add some figures * remove the idea code * get it untitled * remove * add .idea dev tools * remove simple config * get config back * detailing tests and simplifying the setup * Commit TLS support guide Co-authored-by: Salem <[email protected]> * make the statement terser * delete unused img * rewording * back to the old path * Update README.md * Update README.md * Update README.md * Update README.md Co-authored-by: Salem <[email protected]> * Initialize Go Modules `go mod init github.com/hound-search/hound` * Replace jteeuwen/go-bindata with go-bindata/go-bindata The former package is unmainatained since a while and the replacement also fixes this bug I encountered when trying to build the package: jteeuwen/discussions#6 * update Go version requirement in README file * Add a -version flag to Houndd (hound-search#362) This commit adds a `-version` flag to houndd. Running `houndd -version` prints the current version and exits. Co-authored-by: Kartikay Shandil <[email protected]> * Add padding between advanced mode text inputs * add margin bottom to fields that are not last * update front end bundles Co-authored-by: Blobb Ered <@blobbered> * Setup Github Actions CI (hound-search#354) * Setup Github Actions CI Replaces Travis CI with Github Actions for better integration. Jobs are run against more recent Go versions, namely 1.12 to 1.14 . . For further documentation see - https://github.com/actions/setup-go - and https://help.github.com/en/actions This adds `-race` flag to the Go tests and will run a meta linter (golangci-lint). * keep travis in until github workflows is tested * tidy go mods * remove lint command from github workflow * add back go-bindata to go modules list * up version of actions checkout to fix deprecation errors * return go bindata to the go.sum file as well Co-authored-by: Andreas Linz <[email protected]> * Add a github actions badge Thanks again @klingtnet and @blobbered for making this possible! * Update README.md (hound-search#369) Add clarification of using file:// protocol for accessing locally pulled repos * Added new folder docs with config-options description on options. (hound-search#370) * Added new folder docs with config-options description on options. * Peer review comment update updated formatting for config options documentation and added link in readme. * readme link update * link update * Minor edits from code review Co-authored-by: kayyapil <[email protected]> Co-authored-by: ehrktia <[email protected]> Co-authored-by: Salem <[email protected]> * Test windows * Run Go build and test on Ubuntu Linux and Windows * Add lint * Install dependencies in Dockerfile * Fix typo * Adding a tip for windows users (hound-search#379) * Adding a tip for windows users * Update README.md Co-authored-by: Salem <[email protected]> Co-authored-by: Salem <[email protected]> * Use tini as default entry point (hound-search#376) * Add a warning for the default branch rename (hound-search#380) * Add a warning for the default branch rename * Add a link to Github's renaming documentation. * Update README to reflect branch rename. (hound-search#384) * Update version in main.go * support github webhook * Omit ports in constructed URL (hound-search#383) * Improve accessibility (hound-search#398) * Resolve WCAG2AA.Principle3.Guideline3_1.3_1_1.H57.2 * Resolve WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.InputText.Name * Resolve WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.Button.Name * Improve stats contrast * Improve advanced text contrast * Improve repo title contrast * Improve contrast in advanced section * Improve line number contrast * Improve excluded files contrast * Improve "load all" button contrast * Automatically build docker image and publish to ghcr.io (hound-search#401) * Feat: Use goreleaser * Feat: Add docker build, remove goreleaser * Fix: Add image name * Feat: Use ghcr.io and build-push-action@2 * We try again * Trying yet again * Fix: Use actor and GITHUB_TOKEN * Fix: Use github.actor in image tag path * Fix: use github.repository_owner instead of github.actor When you have an organisation, github.actor != github.repository_owner Co-authored-by: Jone Marius Vignes <[email protected]> * Update default-config.json (hound-search#391) * Update default-config.json * Update default-config.json (ref: main) * Add hyperlinks to repository root (hound-search#396) * Add literal search option (hound-search#397) * Add literal search option * Pull EscapeRegExp into common.js * Add db/ to Jest ignore patterns * Test EscapeRegExp() matches its input * Test vacuous EscapeRegExp * Give repo links a target of blank (hound-search#404) Add rel="noopener noreferrer" to _blank links Co-authored-by: Joseph Price <[email protected]> Co-authored-by: dschott <[email protected]> Co-authored-by: Nicolas R <[email protected]> Co-authored-by: Igor <[email protected]> Co-authored-by: Salem <[email protected]> Co-authored-by: Richard Liang <[email protected]> Co-authored-by: Vincent Rischmann <[email protected]> Co-authored-by: Blobb Ered <[email protected]> Co-authored-by: Rebecca Lau <[email protected]> Co-authored-by: Ruixi Fan <[email protected]> Co-authored-by: Ruixi Fan <[email protected]> Co-authored-by: Andreas Linz <[email protected]> Co-authored-by: Rebecca Lau <[email protected]> Co-authored-by: Kartikay Shandil <[email protected]> Co-authored-by: Kartikay Shandil <[email protected]> Co-authored-by: Ashley Roach <[email protected]> Co-authored-by: karthick <[email protected]> Co-authored-by: kayyapil <[email protected]> Co-authored-by: ehrktia <[email protected]> Co-authored-by: David Kolossa <[email protected]> Co-authored-by: Sandro <[email protected]> Co-authored-by: Andrew Stanton <[email protected]> Co-authored-by: David Schott <[email protected]> Co-authored-by: Cor Bosman <[email protected]> Co-authored-by: Jacob Rose <[email protected]> Co-authored-by: Alexander Chiu <[email protected]> Co-authored-by: Joel Armstrong <[email protected]> Co-authored-by: Jone Marius Vignes <[email protected]> Co-authored-by: Jone Marius Vignes <[email protected]> Co-authored-by: Simon Legner <[email protected]> Co-authored-by: Bucky Schwarz <[email protected]>

salemhilal reviewed Oct 26, 2020

View reviewed changes

keep travis in until github workflows is tested

5631df4

blobbered added 3 commits November 5, 2020 12:07

Merge branch 'master' of github.com:hound-search/hound into github-ac…

7634a84

…tions-ci

tidy go mods

36ad8d5

remove lint command from github workflow

e910b07

blobbered added 2 commits November 9, 2020 11:30

add back go-bindata to go modules list

94a32c7

up version of actions checkout to fix deprecation errors

c7fe055

blobbered force-pushed the github-actions-ci branch from a3a7b6f to c7fe055 Compare November 9, 2020 17:01

salemhilal reviewed Nov 10, 2020

View reviewed changes

return go bindata to the go.sum file as well

f8ee655

salemhilal merged commit f83e108 into hound-search:master Nov 11, 2020

salemhilal mentioned this pull request Jan 19, 2022

Maintenance #341

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Setup Github Actions CI #354

Setup Github Actions CI #354

blobbered commented Oct 15, 2020 •

edited

Loading

salemhilal Oct 26, 2020

salemhilal left a comment

salemhilal commented Oct 30, 2020

blobbered commented Nov 5, 2020

salemhilal commented Nov 6, 2020

blobbered commented Nov 9, 2020

salemhilal Nov 10, 2020

blobbered Nov 10, 2020

salemhilal Nov 11, 2020

salemhilal commented Nov 11, 2020

Setup Github Actions CI #354

Setup Github Actions CI #354

Conversation

blobbered commented Oct 15, 2020 • edited Loading

salemhilal Oct 26, 2020

Choose a reason for hiding this comment

salemhilal left a comment

Choose a reason for hiding this comment

salemhilal commented Oct 30, 2020

blobbered commented Nov 5, 2020

salemhilal commented Nov 6, 2020

blobbered commented Nov 9, 2020

salemhilal Nov 10, 2020

Choose a reason for hiding this comment

blobbered Nov 10, 2020

Choose a reason for hiding this comment

salemhilal Nov 11, 2020

Choose a reason for hiding this comment

salemhilal commented Nov 11, 2020

blobbered commented Oct 15, 2020 •

edited

Loading