add ci process (#1)

* add ci process

* add gazelle check

* add cache

* update README

Author: ewhauser

.github/workflows/bazel-ci.yaml

@@ -0,0 +1,33 @@
+name: Bazel CI
+
+on:
+  push:
+    tags:
+      - v*
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Cache bazel
+        uses: actions/cache@v2.1.4
+        env:
+          cache-name: bazel-cache
+        with:
+          path: |
+            ~/.cache/bazelisk
+            ~/.cache/bazel
+          key: ${{ runner.os }}-${{ env.cache-name }}
+      - uses: actions/checkout@v3
+      - name: gazelle check
+        run: bazel run //:gazelle_ci
+      - name: test
+        run: bazel test //...
+      - name: build
+        run: bazel build //...
+      - name: compatibility tests
+        run: ./test.sh

README.md

@@ -13,5 +13,10 @@ A couple reasons:
 
 2. What are the differences from `bazel-diff`?
 
-* Due to some implementation differences, the actual hashes generated by the two programs are different
+* Some of the short codes for the CLI are different (only supporting one character instead of two)
+* Due to some minor implementation differences, the actual hashes generated by the two programs are different
 * `bazel-differ` isn't using `streamed_proto` output from Bazel query (I'm not sure if there is a Go implemntation of this?). In some minimal testing against some large repositories, `bazel-differ` still seems to outperform `bazel-diff` by 2x.
+
+3. What target types has this been tested against?
+
+* `bazel-differ` runs compatibility tests to validate it's target outputs vs. `bazel-diff`. Additional test cases can be added via `tools/test_compatibility.sh`.

cli/BUILD.bazel

@@ -1,22 +1,14 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_binary", "go_library")
 
-go_library(
-    name = "cli",
-    srcs = ["main.go"],
-    importpath = "github.com/ewhauser/bazel-differ/bazel-differ",
-    visibility = ["//visibility:private"],
-    deps = ["//cmd"],
-)
-
 go_binary(
     name = "bazel-differ",
-    embed = [":cli"],
+    embed = [":cli_lib"],
     visibility = ["//visibility:public"],
 )
 
 go_binary(
     name = "bazel-differ-linux-amd64",
-    embed = [":cli"],
+    embed = [":cli_lib"],
     goarch = "amd64",
     goos = "linux",
     pure = "on",
@@ -26,7 +18,7 @@ go_binary(
 
 go_binary(
     name = "bazel-differ-linux-arm64",
-    embed = [":cli"],
+    embed = [":cli_lib"],
     goarch = "arm64",
     goos = "linux",
     pure = "on",
@@ -36,7 +28,7 @@ go_binary(
 
 go_binary(
     name = "bazel-differ-darwin-amd64",
-    embed = [":cli"],
+    embed = [":cli_lib"],
     goarch = "amd64",
     goos = "darwin",
     pure = "on",
@@ -46,10 +38,18 @@ go_binary(
 
 go_binary(
     name = "bazel-differ-darwin-arm64",
-    embed = [":cli"],
+    embed = [":cli_lib"],
     goarch = "arm64",
     goos = "darwin",
     pure = "on",
     static = "on",
     visibility = ["//visibility:public"],
 )
+
+go_library(
+    name = "cli_lib",
+    srcs = ["main.go"],
+    importpath = "github.com/ewhauser/bazel-differ/cli",
+    visibility = ["//visibility:private"],
+    deps = ["//cmd"],
+)