diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..cf42fbc --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,34 @@ +name: goreleaser + +on: + push: + tags: + - "*" + +permissions: + contents: write + +jobs: + goreleaser: + runs-on: ubuntu-latest + steps: + - + name: Checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 + - + name: Set up Go + uses: actions/setup-go@v4 + - + name: Run GoReleaser + uses: goreleaser/goreleaser-action@v4 + with: + # either 'goreleaser' (default) or 'goreleaser-pro' + distribution: goreleaser + version: latest + args: release --clean + env: + GITHUB_TOKEN: ${{ secrets.HUB_TOKEN }} + # Your GoReleaser Pro key, if you are using the 'goreleaser-pro' distribution + # GORELEASER_KEY: ${{ secrets.GORELEASER_KEY }} diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..af37140 --- /dev/null +++ b/Makefile @@ -0,0 +1,23 @@ +.PHONY: build install release +# Initialize Githooks, along with anything else needed to dev and build this repo +init: + git config core.hooksPath .githooks + +default: build + +dep: + @go mod tidy && go mod download + + +build: + @go build + + +install: + @go install + +test: + @go test ./... -race -cover -coverprofile coverage.txt -covermode=atomic + +release: + goreleaser release diff --git a/readme.org b/readme.org index f638a02..04020d5 100644 --- a/readme.org +++ b/readme.org @@ -5,6 +5,27 @@ Hound aspires to be the only tool you need to get all the information for a website. +** Installation +:PROPERTIES: +:CUSTOM_ID: installation +:END: + +*** Method 1 +:PROPERTIES: +:CUSTOM_ID: method-1 +:END: +If Go is installed on the machine +#+begin_src shell + go install github.com/mrprofessor/hound@latest +#+end_src + +*** Method 2 +:PROPERTIES: +:CUSTOM_ID: method-2 +:END: + +Download the lastest release from [[https://github.com/mrprofessor/hound/releases][the release page.]] + ** Initial basic usage :PROPERTIES: :CUSTOM_ID: initial-basic-usage