Skip to content

Commit

Permalink
Add goreleaser configuration
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Mikusa <[email protected]>
  • Loading branch information
dmikusa committed Nov 2, 2024
1 parent b0ca61d commit 7d3b663
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
version: 2

before:
hooks:
- go mod tidy

builds:
- env:
- CGO_ENABLED=0
goos:
- linux
- windows
- darwin

archives:
- format: tar.gz
# this name template makes the OS and Arch compatible with the results of `uname`.
name_template: >-
{{ .ProjectName }}_
{{- title .Os }}_
{{- if eq .Arch "amd64" }}x86_64
{{- else if eq .Arch "386" }}i386
{{- else }}{{ .Arch }}{{ end }}
{{- if .Arm }}v{{ .Arm }}{{ end }}
# use zip for windows archives
format_overrides:
- goos: windows
format: zip

changelog:
sort: asc
filters:
exclude:
- "^docs:"
- "^test:"
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,17 @@ Flags:
--version string the new version of the dependency
```

## Making a Release

The project uses Goreleaser for release management. The following steps can be used to cut a release.

1. Tag a new release. `git tag -a vX.Y.Z -m "vX.Y.Z Release"`
2. Push up the tag. `git push origin vX.Y.Z`
3. Set Github Token. `export GITHUB_TOKEN=<your-release-token>`
4. Run Goreleaser. `goreleaser release`

You can install Goreleaser with `brew install goreleaser`.

## License

This library is released under version 2.0 of the [Apache License][a].
Expand Down

0 comments on commit 7d3b663

Please sign in to comment.