Skip to content

Commit 8d350b6

Browse files
authored
Merge pull request #238 from sapcc/fix/goreleaser-config-key
fix goreleaser config key
2 parents 61f78aa + cab9c7d commit 8d350b6

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The config file has the following sections:
5353
* [dockerfile](#dockerfile)
5454
* [golang](#golang)
5555
* [golangciLint](#golangcilint)
56-
* [GoReleaser](#goreleaser)
56+
* [goReleaser](#goreleaser)
5757
* [makefile](#makefile)
5858
* [metadata](#metadata)
5959
* [renovate](#renovate)
@@ -207,17 +207,17 @@ for function signatures that `errcheck` accepts.
207207

208208
Take a look at `go-makefile-maker`'s own [`golangci-lint` config file](./.golangci.yaml) for an up-to-date example of what the generated config would look like.
209209

210-
### `goreleaser`
210+
### `goReleaser`
211211

212212
```yaml
213-
goreleaser:
213+
goReleaser:
214214
createConfig: true
215215
binaryName: "{{ .ProjectName }}_{{ .Os }}_{{ .Arch }}"
216216
format: .tar.gz
217217
nameTemplate: "{{ .ProjectName }}_{{ .Os }}_{{ .Arch }}"
218218
```
219219

220-
If `goreleaser.createConfig` is set to true or it is unset but the release GitHub Workflow is enabled, a config file for goreleaser will be generated based on the metadata of the repository.
220+
If `goReleaser.createConfig` is set to true or it is unset but the release GitHub Workflow is enabled, a config file for goreleaser will be generated based on the metadata of the repository.
221221
The `format` option can be used to only upload binaries. It corresponds to the upstream archives[].format option. See <https://goreleaser.com/customization/archive/> for more details.
222222
The `binaryName` option can be used to change the name of the compiled binaries. It corresponds to the upstream builds[].binary option. This is only really useful when format is set to binary. It defaults to name of the first entry in the binaries option.
223223
The `nameTemplate` option can be used to change the name of uploaded release artefacts. It corresponds to the upstream archives[].name_template option.
@@ -475,7 +475,7 @@ pushContainerToGhcr:
475475

476476
If `release` is enabled a workflow is generated which creates a new GitHub release using goreleaser when a git tag is pushed.
477477

478-
`goreleaser.enabled` will be enabled automatically when the option isn't set yet.
478+
`goReleaser.enabled` will be enabled automatically when the option isn't set yet.
479479

480480
#### `githubWorkflow.securityChecks`
481481

0 commit comments

Comments
 (0)