diff --git a/.github/workflows/go-build.yml b/.github/workflows/go-build.yml index c9ab2d5..167fb47 100644 --- a/.github/workflows/go-build.yml +++ b/.github/workflows/go-build.yml @@ -16,8 +16,8 @@ jobs: with: go-version: 1.19 - - name: Build - run: go build -v ./... + - name: Build binary + run: make build/turnkey - name: Test run: go test -v ./... \ No newline at end of file diff --git a/.gitignore b/.gitignore index b90d5f8..cc7bc14 100644 --- a/.gitignore +++ b/.gitignore @@ -14,5 +14,6 @@ # Apple folder files .DS_Store -# Dist folder -dist/ \ No newline at end of file +# Dist/build folder +dist/ +build/ diff --git a/README.md b/README.md index fbec1f9..b6b0f19 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,17 @@ # Turnkey CLI +![Go Build Status](https://github.com/tkhq/tkcli/actions/workflows/go-build.yml/badge.svg) + ## Building the CLI +If you simply want to build a binary locally, run +```sh +$ make build/turnkey +``` + We use [GoReleaser](https://goreleaser.com/) to build and release our binaries. -To build locally: +To build a release locally: ``` $ goreleaser release --snapshot --rm-dist ``` diff --git a/build/.gitattributes b/build/.gitattributes deleted file mode 100644 index 28add19..0000000 --- a/build/.gitattributes +++ /dev/null @@ -1 +0,0 @@ -turnkey filter=lfs diff=lfs merge=lfs -text \ No newline at end of file diff --git a/build/turnkey b/build/turnkey deleted file mode 100755 index 7da4427..0000000 --- a/build/turnkey +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:f1ba9392d17c23035e3a528b0fcd3119f21637c66a4d727202fc2f066aeb1d94 -size 9268610