Skip to content

Commit

Permalink
build: add homebrew formula publishing
Browse files Browse the repository at this point in the history
Signed-off-by: Gabor Boros <gabor.brs@gmail.com>
  • Loading branch information
gabor-boros committed Nov 8, 2021
1 parent eb4b9e8 commit 82d115c
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 2 deletions.
22 changes: 22 additions & 0 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)_
Expand Down Expand Up @@ -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
[coverage-url]: https://codeclimate.com/github/gabor-boros/minutes/test_coverage
13 changes: 12 additions & 1 deletion www/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 82d115c

Please sign in to comment.