Skip to content

Commit 14ac351

Browse files
offbyoneoffbyone
committed
Add comprehensive goreleaser support for multi-platform builds
This change replaces the custom build-all.sh script with a full goreleaser integration that provides: ## What's Added ### Configuration - : Configures builds for macOS and Linux (arm64 and amd64) with proper archiving, checksums, and changelog generation - : Provides convenient commands for common release tasks (build, test, snapshot, clean, etc.) ### Version Management - Removes hardcoded version from main.go (was "2.5.1") - Uses goreleaser's ldflags injection for version from git tags - Fallback to "dev" version when building locally ### CI/CD Integration - Updates : Adds goreleaser snapshot builds on PRs with artifact uploads - Adds : Automates releases when tags are pushed ## Benefits - **Tag-based versioning**: Version is automatically derived from git tags - **Snapshot builds**: Test releases locally or in CI without creating actual releases - **Simplified workflow**: Single command for testing builds - **Better CI feedback**: PR builds now validate the full release process - **Automated releases**: Push a tag, get a GitHub release with all platform binaries ## Migration Notes - The build-all.sh script is now superseded but kept for backward compatibility - Existing release process: Create and push a git tag (e.g., v2.5.2) - For local testing: Run to create test builds in ./dist/ ## Platform Support Currently building for: - macOS (darwin): amd64, arm64 - Linux: amd64, arm64 FreeBSD builds from build-all.sh can be added if needed by extending .goreleaser.yml
1 parent f57a6d0 commit 14ac351

7 files changed

Lines changed: 186 additions & 11 deletions

File tree

‎.github/workflows/build.yml‎

Lines changed: 58 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,34 @@
11
name: Build
22

33
on:
4-
- push
5-
- pull_request
4+
push:
5+
branches:
6+
- main
7+
- master
8+
pull_request:
9+
10+
permissions:
11+
contents: read
612

713
jobs:
814
build:
915
runs-on: ubuntu-latest
16+
permissions:
17+
contents: read
1018
strategy:
1119
matrix:
1220
go-version: ["1.18.x", "1.19.x", "1.20.x", "1.21.x"]
1321
steps:
1422
- name: Checkout
15-
uses: actions/checkout@v3
16-
- uses: actions/setup-go@v3
23+
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.2.2
24+
with:
25+
fetch-depth: 0
26+
persist-credentials: false
27+
- uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.3.0
1728
with:
1829
go-version: ${{ matrix.go-version }}
1930
- name: Cache mods
20-
uses: actions/cache@v3
31+
uses: actions/cache@6f8efc29b200d32929f49075959781ed54ec270c # v3.4.2
2132
with:
2233
path: |
2334
~/.cache/go-build
@@ -27,3 +38,45 @@ jobs:
2738
run: go mod download
2839
- name: Build
2940
run: go build
41+
42+
zizmor:
43+
runs-on: ubuntu-latest
44+
permissions:
45+
contents: read
46+
security-events: write
47+
steps:
48+
- name: Checkout
49+
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.2.2
50+
with:
51+
persist-credentials: false
52+
- name: Run zizmor
53+
uses: zizmorcore/zizmor-action@e639db99335bc9038abc0e066dfcd72e23d26fb4 # v0.3.0
54+
with:
55+
inputs: .github/workflows/
56+
57+
goreleaser-snapshot:
58+
runs-on: ubuntu-latest
59+
permissions:
60+
contents: read
61+
if: github.event_name == 'pull_request'
62+
steps:
63+
- name: Checkout
64+
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.2.2
65+
with:
66+
fetch-depth: 0
67+
persist-credentials: false
68+
- uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.3.0
69+
with:
70+
go-version: "1.21.x"
71+
cache: false
72+
- name: Run GoReleaser (snapshot)
73+
uses: goreleaser/goreleaser-action@9ed2f89a662b9c5e6c31f6b2bb75f49fff0db6e8 # v6.4.0
74+
with:
75+
distribution: goreleaser
76+
version: latest
77+
args: release --snapshot --clean
78+
- name: Upload artifacts
79+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
80+
with:
81+
name: dist
82+
path: dist/

‎.github/workflows/lint.yml‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,27 @@ on:
44
- push
55
- pull_request
66

7+
permissions:
8+
contents: read
9+
710
jobs:
811
lint:
912
runs-on: ubuntu-latest
13+
permissions:
14+
contents: read
1015
strategy:
1116
matrix:
1217
go-version: ["1.21.x"]
1318
steps:
1419
- name: Checkout
15-
uses: actions/checkout@v3
16-
- uses: actions/setup-go@v3
20+
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.2.2
21+
with:
22+
persist-credentials: false
23+
- uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.3.0
1724
with:
1825
go-version: ${{ matrix.go-version }}
1926
- name: Cache mods
20-
uses: actions/cache@v3
27+
uses: actions/cache@6f8efc29b200d32929f49075959781ed54ec270c # v3.4.2
2128
with:
2229
path: |
2330
~/.cache/go-build
@@ -26,7 +33,7 @@ jobs:
2633
- name: Download mods
2734
run: go mod download
2835
- name: Lint
29-
uses: golangci/golangci-lint-action@v3
36+
uses: golangci/golangci-lint-action@55c2c1448f86e01eaae002a5a3a9624417608d84 # v6.3.0
3037
with:
3138
version: v1.54.1
3239
args: --timeout 5m0s

‎.github/workflows/release.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags:
6+
- "v*"
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
goreleaser:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- name: Checkout
16+
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.2.2
17+
with:
18+
fetch-depth: 0
19+
persist-credentials: false
20+
- name: Set up Go
21+
uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5.3.0
22+
with:
23+
go-version: "1.21.x"
24+
cache: false
25+
- name: Run GoReleaser
26+
uses: goreleaser/goreleaser-action@9ed2f89a662b9c5e6c31f6b2bb75f49fff0db6e8 # v6.4.0
27+
with:
28+
distribution: goreleaser
29+
version: latest
30+
args: release --clean
31+
env:
32+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.goreleaser.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
version: 2
2+
3+
before:
4+
hooks:
5+
- go mod tidy
6+
7+
builds:
8+
- env:
9+
- CGO_ENABLED=0
10+
goos:
11+
- linux
12+
- darwin
13+
goarch:
14+
- amd64
15+
- arm64
16+
ldflags:
17+
- -s -w
18+
- -X main.version={{.Version}}
19+
20+
archives:
21+
- name_template: "{{ .ProjectName }}-{{ .Version }}-{{ .Os }}-{{ .Arch }}"
22+
files:
23+
- LICENSE*
24+
- README*
25+
- CHANGELOG*
26+
27+
checksum:
28+
name_template: "checksums.txt"
29+
algorithm: sha256
30+
31+
snapshot:
32+
version_template: "{{ incpatch .Version }}-next"
33+
34+
changelog:
35+
sort: asc
36+
filters:
37+
exclude:
38+
- "^docs:"
39+
- "^test:"
40+
- "^chore:"
41+
- "^ci:"
42+
43+
release:
44+
draft: false
45+
prerelease: auto
46+
name_template: "{{.ProjectName}} {{.Version}}"

‎go.mod‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ module github.com/DarthSim/overmind/v2
33
go 1.21
44

55
require (
6+
github.com/Envek/godotenv v0.0.0-20240326021258-e36c8a003587
67
github.com/matoous/go-nanoid v1.5.0
78
github.com/sevlyar/go-daemon v0.1.6
89
github.com/urfave/cli v1.22.12
910
golang.org/x/term v0.4.0
1011
)
1112

1213
require (
13-
github.com/Envek/godotenv v0.0.0-20240326021258-e36c8a003587 // indirect
1414
github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
1515
github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 // indirect
1616
github.com/russross/blackfriday/v2 v2.1.0 // indirect

‎justfile‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Build a local development version
2+
build:
3+
go build -ldflags "-X main.version=dev" -o overmind .
4+
5+
# Run tests
6+
test:
7+
go test -v ./...
8+
9+
# Run linter
10+
lint:
11+
golangci-lint run --timeout 5m0s
12+
13+
# Build a snapshot release (useful for testing)
14+
snapshot:
15+
goreleaser release --snapshot --clean
16+
17+
# Check if the goreleaser config is valid
18+
check-config:
19+
goreleaser check
20+
21+
# Clean build artifacts
22+
clean:
23+
rm -rf ./dist
24+
rm -f overmind
25+
26+
# Show current version from git tags
27+
version:
28+
@git describe --always --tags --abbrev=0 2>/dev/null || echo "no tags found"
29+
30+
# Install goreleaser (if not already installed)
31+
install-goreleaser:
32+
@which goreleaser > /dev/null || (echo "Installing goreleaser..." && go install github.com/goreleaser/goreleaser/v2@latest)
33+
34+
# Local release (requires goreleaser to be installed)
35+
release: install-goreleaser
36+
goreleaser release --clean

‎main.go‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@ import (
1212
"github.com/urfave/cli"
1313
)
1414

15-
const version = "2.5.1"
15+
// version will be set by goreleaser via ldflags
16+
var version = "dev"
1617

1718
func socketFlags(s, n *string) []cli.Flag {
1819
return []cli.Flag{

0 commit comments

Comments
 (0)