From 22cdff9506529de13cb421c3d852a5b26b881536 Mon Sep 17 00:00:00 2001 From: Kei Kamikawa Date: Mon, 29 Mar 2021 11:57:11 +0900 Subject: [PATCH] fixed goreleaser --- .github/workflows/release.yml | 1 + .goreleaser.yml | 1 + README.md | 12 ++++++++++++ 3 files changed, 14 insertions(+) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 217740827f384..a9b5a5dd797f8 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -22,3 +22,4 @@ jobs: args: release --rm-dist env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + HOMEBREW_TAP_GITHUB_TOKEN: ${{ secrets.HOMEBREW_TAP_GITHUB_TOKEN }} diff --git a/.goreleaser.yml b/.goreleaser.yml index 74d9ad6a7e410..a542ac8c176d2 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -49,6 +49,7 @@ brews: tap: owner: Code-Hex name: homebrew-tap + token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}" homepage: "https://github.com/Code-Hex/gqldoc" description: "The easiest way to make documents for GraphQL" folder: Formula diff --git a/README.md b/README.md index 34215fc138a6b..c713debb5b949 100644 --- a/README.md +++ b/README.md @@ -36,12 +36,24 @@ $ gqldoc -s a.graphql -s b.graphql -o ./doc_dir ## Installation +### Mac and Linux users via Homebrew + +```sh +$ brew install Code-Hex/tap/gqldoc +``` + +### Manually via go command + Again, this tool is supported Go 1.16 and above. If you are one of those users, you can install like below. ```sh $ go install github.com/Code-Hex/gqldoc/cmd/gqldoc ``` +### Manually download + +You can download binary from [here](https://github.com/Code-Hex/gqldoc/releases) + ## Todo This todo list is written the order of priority.