From 9423da1b607b26916664cb26016811b54359e46c Mon Sep 17 00:00:00 2001 From: Rico Date: Sun, 20 Dec 2020 14:56:00 +0100 Subject: [PATCH] docs: unify naming of .goreleaser.yml file (#1955) Since multiple filenames for the config file are allowed, we find several different usages of the file names in the docs: - .goreleaser.yml - goreleaser.yml - .goreleaser.yaml - goreleaser.yaml I find that using a single filename in the docs is more intuitive for new users. Hence I replaced all occurrences of the filename with `.goreleaser.yml`. --- cmd/testdata/good.yml | 2 +- internal/static/config.go | 2 +- www/docs/customization/archive.md | 6 +++--- www/docs/customization/build.md | 4 ++-- www/docs/customization/docker_manifest.md | 2 +- www/docs/customization/env.md | 2 +- www/docs/customization/sign.md | 4 ++-- www/docs/deprecations.md | 2 +- www/docs/quick-start.md | 2 +- 9 files changed, 13 insertions(+), 13 deletions(-) diff --git a/cmd/testdata/good.yml b/cmd/testdata/good.yml index 462e7201e..9b632620a 100644 --- a/cmd/testdata/good.yml +++ b/cmd/testdata/good.yml @@ -1,4 +1,4 @@ -# This is an example goreleaser.yaml file with some sane defaults. +# This is an example .goreleaser.yml file with some sane defaults. # Make sure to check the documentation at http://goreleaser.com before: hooks: diff --git a/internal/static/config.go b/internal/static/config.go index b1ebdd139..41b8c0b5b 100644 --- a/internal/static/config.go +++ b/internal/static/config.go @@ -5,7 +5,7 @@ package static // ExampleConfig is the config used within goreleaser init. // nolint: gochecknoglobals -const ExampleConfig = `# This is an example goreleaser.yaml file with some sane defaults. +const ExampleConfig = `# This is an example .goreleaser.yml file with some sane defaults. # Make sure to check the documentation at http://goreleaser.com before: hooks: diff --git a/www/docs/customization/archive.md b/www/docs/customization/archive.md index 3b3bb47b7..374320ffd 100644 --- a/www/docs/customization/archive.md +++ b/www/docs/customization/archive.md @@ -98,7 +98,7 @@ on the archive section. A working hack is to use something like this: ```yaml -# goreleaser.yml +# .goreleaser.yml archives: - files: - none* @@ -119,7 +119,7 @@ Presumably, you'll want that file to be the binary, so, your archive section will probably look like this: ```yaml -# goreleaser.yml +# .goreleaser.yml archives: - format: gz files: @@ -138,7 +138,7 @@ extracted with something like `gzip -d file.gz`. You can do that by setting `format` to `binary`: ```yaml -# goreleaser.yml +# .goreleaser.yml archives: - format: binary ``` diff --git a/www/docs/customization/build.md b/www/docs/customization/build.md index eac50cb51..6b44b8dbc 100644 --- a/www/docs/customization/build.md +++ b/www/docs/customization/build.md @@ -132,7 +132,7 @@ builds: Here is an example with multiple binaries: ```yaml -# goreleaser.yml +# .goreleaser.yml builds: - main: ./cmd/cli/cli.go id: "cli" @@ -243,7 +243,7 @@ Environment variables are inherited and overridden in the following order: very likely to fail. You can solve this by running `go mod download` before calling `goreleaser` or - by adding a [hook][] doing that on your `.goreleaser.yaml` file: + by adding a [hook][] doing that on your `.goreleaser.yml` file: ```yaml before: diff --git a/www/docs/customization/docker_manifest.md b/www/docs/customization/docker_manifest.md index 71ce15b02..932731438 100644 --- a/www/docs/customization/docker_manifest.md +++ b/www/docs/customization/docker_manifest.md @@ -81,7 +81,7 @@ Then, on our GoReleaser config file, we need to define both the `dockers` and the `docker_manifests` section: ```yaml -# goreleaser.yml +# .goreleaser.yml builds: - env: - CGO_ENABLED=0 diff --git a/www/docs/customization/env.md b/www/docs/customization/env.md index d7a102fc4..84fb8becb 100644 --- a/www/docs/customization/env.md +++ b/www/docs/customization/env.md @@ -5,7 +5,7 @@ title: Environment Variables Global environment variables to be passed down to all hooks and builds. This is useful for `GO111MODULE`, for example. You can have your -`.goreleaser.yaml` file like the following: +`.goreleaser.yml` file like the following: ```yaml # .goreleaser.yml diff --git a/www/docs/customization/sign.md b/www/docs/customization/sign.md index 0523a9e97..47a7f6cd0 100644 --- a/www/docs/customization/sign.md +++ b/www/docs/customization/sign.md @@ -18,7 +18,7 @@ with [GnuPG](https://www.gnupg.org/) and your default key. To enable signing just add ```yaml -# goreleaser.yml +# .goreleaser.yml signs: - artifacts: checksum ``` @@ -86,7 +86,7 @@ If what you want to use does not do it, you can always hack by setting the command to `sh -c`. For example: ```yaml -# goreleaser.yml +# .goreleaser.yml signs: - cmd: sh args: diff --git a/www/docs/deprecations.md b/www/docs/deprecations.md index 2a2974112..764bd0139 100644 --- a/www/docs/deprecations.md +++ b/www/docs/deprecations.md @@ -383,7 +383,7 @@ FPM is deprecated in favor of nfpm, which is a simpler alternative written in Go. The objective is to remove the ruby dependency thus simplify the CI/CD pipelines. -Just replace the `fpm` keyword by `nfpm` in your `goreleaser.yaml` file. +Just replace the `fpm` keyword by `nfpm` in your `.goreleaser.yml` file. === "Before" ```yaml diff --git a/www/docs/quick-start.md b/www/docs/quick-start.md index 78e4c4cfe..e57a31b1a 100644 --- a/www/docs/quick-start.md +++ b/www/docs/quick-start.md @@ -13,7 +13,7 @@ func main() { } ``` -Run `goreleaser init` to create an example `.goreleaser.yaml` file: +Run `goreleaser init` to create an example `.goreleaser.yml` file: ```sh goreleaser init