From 82d115c8eda1e2724d5724da622a79b08acb0fb5 Mon Sep 17 00:00:00 2001 From: Gabor Boros Date: Mon, 8 Nov 2021 07:55:25 +0100 Subject: [PATCH] build: add homebrew formula publishing Signed-off-by: Gabor Boros --- .goreleaser.yml | 22 ++++++++++++++++++++++ README.md | 13 ++++++++++++- www/docs/getting-started.md | 13 ++++++++++++- 3 files changed, 46 insertions(+), 2 deletions(-) diff --git a/.goreleaser.yml b/.goreleaser.yml index e05b6c8..0a58a10 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -28,3 +28,25 @@ milestones: fail_on_error: true changelog: skip: true +brews: + - + tap: + owner: gabor-boros + name: homebrew-brew + commit_author: + name: "Gabor Boros" + email: gabor.brs@gmail.com + folder: Formula + homepage: "/~https://github.com/gabor-boros/minutes" + description: "Sync worklogs between time trackers, invoicing, and bookkeeping software" + license: "MIT" + dependencies: + - name: go + type: build + custom_block: | + head "/~https://github.com/gabor-boros/minutes", branch: "main" + + livecheck do + url "/~https://github.com/gabor-boros/minutes/releases" + regex(/^v(\d+(?:\.\d+)+)$/i) + end diff --git a/README.md b/README.md index 889e7e2..336ae7a 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,19 @@ Based on the nature of the project, prerequisites depending on what tools you ar ### Installation +#### Using `brew` + +``` shell +$ brew tap gabor-boros/brew +$ brew install minutes +``` + +#### Manual install + To install `minutes`, use one of the [release artifacts](/~https://github.com/gabor-boros/minutes/releases). If you have `go` installed, you can build from source as well. +#### Configuration + `minutes` has numerous flags and there will be more when other sources or targets are added. Therefore, `minutes` comes with a config file, that can be placed to the user's home directory or the config directory. _To read more about the config file, please refer to the [Documentation](https://gabor-boros.github.io/minutes/getting-started)_ @@ -231,4 +242,4 @@ Don't forget to give the project a star! [maintainability-shield]: https://api.codeclimate.com/v1/badges/316725f57830f48733e8/maintainability [maintainability-url]: https://codeclimate.com/github/gabor-boros/minutes/maintainability [coverage-shield]: https://api.codeclimate.com/v1/badges/316725f57830f48733e8/test_coverage -[coverage-url]: https://codeclimate.com/github/gabor-boros/minutes/test_coverage \ No newline at end of file +[coverage-url]: https://codeclimate.com/github/gabor-boros/minutes/test_coverage diff --git a/www/docs/getting-started.md b/www/docs/getting-started.md index c4eb537..6d6b76e 100644 --- a/www/docs/getting-started.md +++ b/www/docs/getting-started.md @@ -4,7 +4,18 @@ This guide show you the basics `minutes`, walks through the available flags, and ## Installation -To install `minutes`, use one of the [release artifacts](/~https://github.com/gabor-boros/minutes/releases). If you have `go` installed, you can build from source as well. +### Using `brew` + +``` shell +$ brew tap gabor-boros/brew +$ brew install minutes +``` + +### Manual install + +To install `minutes`, use one of the [release artifacts](/~https://github.com/gabor-boros/minutes/releases). If you have `go` installed, you can build from source as well + +### Configuration `minutes` has numerous flags and there will be more when other sources or targets are added. Therefore, `minutes` comes with a config file, that can be placed to the user's home directory or the config directory.