feat: add commands to .goreleaser.yml only if requested

manifest.yaml

@@ -68,6 +68,25 @@ arguments:
               unmanaged:
                 type: boolean
                 description: If true, stencil will not generate an entrypoint go file for this CLI (`cmd/<name>/<name>.go`), but still will build and distribute it.
+              buildAsset:
+                type: boolean
+                description: If true, the command is added to .goreleaser.yml file, otherwise no asset is build for this command
+              arch:
+                type: array
+                description: List of architectures required for building the asset (by default arm64 and amd64)
+                items:
+                  type: string
+                  enum:
+                    - arm64
+                    - amd64
+              os:
+                type: array
+                description: List of os types required for building the asset (by default linux and darwin)
+                items:
+                  type: string
+                  enum:
+                    - linux
+                    - darwin
     description: List of CLI commands to generate for this repository
   grpcClients:
     schema:

templates/.goreleaser.yml.tpl

@@ -1,26 +1,37 @@
 {{- if not (stencil.Arg "commands") }}
-{{ file.Skip "No commands defined" }}
+{{- file.Delete }}
 {{- end -}}
 # yaml-language-server: $schema=https://goreleaser.com/static/schema.json
 before:
   hooks:
     - make dep
-builds:
-{{- range $cmdName := stencil.Arg "commands" }}
+{{- $hasCommands := false }}
+{{- range $index, $cmdName := stencil.Arg "commands" }}
 {{- $opts := (dict) }}
 {{- if kindIs "map" $cmdName }}
 {{- $cmdName = (index (keys $cmdName) 0) }}
 {{- $opts = (index . $cmdName | default (dict)) }}
+{{- end }}
+{{- if $opts.buildAsset }}
+{{- if eq $index 0 }}
+{{- $hasCommands = true }}
+builds:
 {{- end }}
   - main: ./cmd/{{ $cmdName }}
     id: &name {{ $cmdName }}
     binary: *name
     goos:
-      - linux
-      - darwin
+      {{- $defaultOs := (list "linux" "darwin") }}
+      {{- $osList := ($opts.os | default $defaultOs) }}
+      {{- range $os := $osList }}
+      - {{ $os }}
+      {{- end }}
     goarch:
-      - amd64
-      - arm64
+      {{- $defaultArch := (list "arm64" "amd64") }}
+      {{- $archList := ($opts.arch | default $defaultArch) }}
+      {{- range $arch := $archList }}
+      - {{ $arch }}
+      {{- end }}
     ldflags:
       - '-w -s -X "github.com/getoutreach/gobox/pkg/app.Version=v{{ "{{" }} .Version {{ "}}" }}"'
       {{- if not $opts.delibird }}
@@ -34,6 +45,11 @@ builds:
       {{ (file.Block $blockName) | trim }}
       ## <</Stencil::Block>>
       {{- end }}
+{{- end }}
+{{- if not $hasCommands }}
+{{- file.Delete }}
+{{- end -}}
+
 
 archives: []
 checksum:

templates/.snapshots/TestGoreleaserYmlOnlyCommands-.goreleaser.yml.tpl-.goreleaser.yml.snapshot

@@ -0,0 +1,10 @@
+(*codegen.File)(# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
+before:
+  hooks:
+    - make dep<nil>archives: []
+checksum:
+  name_template: 'checksums.txt'
+release:
+  # We handle releasing via semantic-release
+  disable: true
+)

templates/.snapshots/TestGoreleaserYmlWithBuildAsset-.goreleaser.yml.tpl-.goreleaser.yml.snapshot

@@ -0,0 +1,101 @@
+(*codegen.File)(# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
+before:
+  hooks:
+    - make dep
+builds:
+  - main: ./cmd/cmd1
+    id: &name cmd1
+    binary: *name
+    goos:
+      - linux
+      - darwin
+    goarch:
+      - arm64
+      - amd64
+    ldflags:
+      - '-w -s -X "github.com/getoutreach/gobox/pkg/app.Version=v{{ .Version }}"'
+      - '-X "main.HoneycombTracingKey={{ .Env.HONEYCOMB_APIKEY }}"'
+      - '-X "main.TeleforkAPIKey={{ .Env.TELEFORK_APIKEY }}"'
+    env:
+      - CGO_ENABLED=0
+      ## <<Stencil::Block(cmd1AdditionalEnv)>>
+
+      ## <</Stencil::Block>>
+  - main: ./cmd/cmd2
+    id: &name cmd2
+    binary: *name
+    goos:
+      - linux
+      - darwin
+    goarch:
+      - arm64
+      - amd64
+    ldflags:
+      - '-w -s -X "github.com/getoutreach/gobox/pkg/app.Version=v{{ .Version }}"'
+      - '-X "main.HoneycombTracingKey={{ .Env.HONEYCOMB_APIKEY }}"'
+      - '-X "main.TeleforkAPIKey={{ .Env.TELEFORK_APIKEY }}"'
+    env:
+      - CGO_ENABLED=0
+      ## <<Stencil::Block(cmd2AdditionalEnv)>>
+
+      ## <</Stencil::Block>>
+  - main: ./cmd/cmd3-sub1
+    id: &name cmd3-sub1
+    binary: *name
+    goos:
+      - linux
+      - darwin
+    goarch:
+      - arm64
+      - amd64
+    ldflags:
+      - '-w -s -X "github.com/getoutreach/gobox/pkg/app.Version=v{{ .Version }}"'
+      - '-X "main.HoneycombTracingKey={{ .Env.HONEYCOMB_APIKEY }}"'
+      - '-X "main.TeleforkAPIKey={{ .Env.TELEFORK_APIKEY }}"'
+    env:
+      - CGO_ENABLED=0
+      ## <<Stencil::Block(cmd3sub1AdditionalEnv)>>
+
+      ## <</Stencil::Block>>
+  - main: ./cmd/cmd3-sub2
+    id: &name cmd3-sub2
+    binary: *name
+    goos:
+      - linux
+      - darwin
+    goarch:
+      - arm64
+      - amd64
+    ldflags:
+      - '-w -s -X "github.com/getoutreach/gobox/pkg/app.Version=v{{ .Version }}"'
+      - '-X "main.HoneycombTracingKey={{ .Env.HONEYCOMB_APIKEY }}"'
+      - '-X "main.TeleforkAPIKey={{ .Env.TELEFORK_APIKEY }}"'
+    env:
+      - CGO_ENABLED=0
+      ## <<Stencil::Block(cmd3sub2AdditionalEnv)>>
+
+      ## <</Stencil::Block>>
+  - main: ./cmd/cmd4_sub1
+    id: &name cmd4_sub1
+    binary: *name
+    goos:
+      - linux
+      - darwin
+    goarch:
+      - arm64
+      - amd64
+    ldflags:
+      - '-w -s -X "github.com/getoutreach/gobox/pkg/app.Version=v{{ .Version }}"'
+      - '-X "main.HoneycombTracingKey={{ .Env.HONEYCOMB_APIKEY }}"'
+      - '-X "main.TeleforkAPIKey={{ .Env.TELEFORK_APIKEY }}"'
+    env:
+      - CGO_ENABLED=0
+      ## <<Stencil::Block(cmd4sub1AdditionalEnv)>>
+
+      ## <</Stencil::Block>>archives: []
+checksum:
+  name_template: 'checksums.txt'
+release:
+  # We handle releasing via semantic-release
+  disable: true
+)

templates/.snapshots/TestGoreleaserYmlWithSpecifiedOrAndArch-.goreleaser.yml.tpl-.goreleaser.yml.snapshot

@@ -0,0 +1,27 @@
+(*codegen.File)(# yaml-language-server: $schema=https://goreleaser.com/static/schema.json
+before:
+  hooks:
+    - make dep
+builds:
+  - main: ./cmd/cmd1
+    id: &name cmd1
+    binary: *name
+    goos:
+      - linux
+    goarch:
+      - arm64
+    ldflags:
+      - '-w -s -X "github.com/getoutreach/gobox/pkg/app.Version=v{{ .Version }}"'
+      - '-X "main.HoneycombTracingKey={{ .Env.HONEYCOMB_APIKEY }}"'
+      - '-X "main.TeleforkAPIKey={{ .Env.TELEFORK_APIKEY }}"'
+    env:
+      - CGO_ENABLED=0
+      ## <<Stencil::Block(cmd1AdditionalEnv)>>
+
+      ## <</Stencil::Block>>archives: []
+checksum:
+  name_template: 'checksums.txt'
+release:
+  # We handle releasing via semantic-release
+  disable: true
+)

templates/main_test.go

@@ -230,10 +230,10 @@ func TestGRPCServerRPC(t *testing.T) {
 			"grpc",
 		},
 	})
-	st.Run(true)
+	st.Run(stenciltest.RegenerateSnapshots())
 }
 
-func TestGoreleaserYml(t *testing.T) {
+func TestGoreleaserYmlOnlyCommands(t *testing.T) {
 	st := stenciltest.New(t, ".goreleaser.yml.tpl", libraryTmpls...)
 	st.Args(map[string]interface{}{
 		"commands": []interface{}{
@@ -244,7 +244,61 @@ func TestGoreleaserYml(t *testing.T) {
 			"cmd4_sub1",
 		},
 	})
-	st.Run(true)
+	st.Run(stenciltest.RegenerateSnapshots())
+}
+
+func TestGoreleaserYmlWithBuildAsset(t *testing.T) {
+	st := stenciltest.New(t, ".goreleaser.yml.tpl", libraryTmpls...)
+	st.Args(map[string]interface{}{
+		"commands": []any{
+			map[string]any{
+				"cmd1": map[string]any{
+					"buildAsset": true,
+				},
+			},
+			map[string]any{
+				"cmd2": map[string]any{
+					"buildAsset": true,
+				},
+			},
+			map[string]any{
+				"cmd3-sub1": map[string]any{
+					"buildAsset": true,
+				},
+			},
+			map[string]any{
+				"cmd3-sub2": map[string]any{
+					"buildAsset": true,
+				},
+			},
+			map[string]any{
+				"cmd4_sub1": map[string]any{
+					"buildAsset": true,
+				},
+			},
+		},
+	})
+	st.Run(stenciltest.RegenerateSnapshots())
+}
+
+func TestGoreleaserYmlWithSpecifiedOrAndArch(t *testing.T) {
+	st := stenciltest.New(t, ".goreleaser.yml.tpl", libraryTmpls...)
+	st.Args(map[string]interface{}{
+		"commands": []any{
+			map[string]any{
+				"cmd1": map[string]any{
+					"buildAsset": true,
+					"os": []any{
+						"linux",
+					},
+					"arch": []any{
+						"arm64",
+					},
+				},
+			},
+		},
+	})
+	st.Run(stenciltest.RegenerateSnapshots())
 }
 
 func TestRenderGolangcilintYaml(t *testing.T) {