From 7a2fc167c8314aed2afdd83d3c8fd9cacccdf07e Mon Sep 17 00:00:00 2001 From: Khris Richardson <khris.richardson@gmail.com> Date: Sun, 23 Jan 2022 11:29:31 -0800 Subject: [PATCH] docs: update grammar in markdown (#2846) --- www/docs/how-it-works.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/www/docs/how-it-works.md b/www/docs/how-it-works.md index edc390832..853bab2c7 100644 --- a/www/docs/how-it-works.md +++ b/www/docs/how-it-works.md @@ -1,13 +1,15 @@ # How it works -GoReleaser goal is to automate most of the boring work you'll had while releasing software. -Ideally, using sensible defaults and making the most common usecases easy. +GoReleaser's goal is to automate most of the boring work you'll have while +releasing software, ideally using sensible defaults and making the most common +use cases easy. GoReleaser expects a couple of things: -- a `.goreleaser.yaml` file with the configuration (see the [customization section](/customization) for more info) +- a `.goreleaser.yaml` file with the configuration (see the + [customization section](/customization) for more info) - a clean working tree -- a SemVer-compatible version (e.g. `10.21.34-something`) +- a SemVer-compatible version (e.g. `10.21.34-prerelease+buildmeta`) And that's it. @@ -17,9 +19,11 @@ A GoReleaser run is split into 4 major steps: - **defaulting**: configures sensible defaults for each step - **building**: builds the binaries, archives, packages, Docker images, etc -- **publishing**: publishes the release to the configured SCM, Docker registries, blob storages... +- **publishing**: publishes the release to the configured SCM, Docker + registries, blob storages... - **announcing**: announces your release to the configured channels -Some steps might be skipped with `--skip-foo`-like flags (check the [command line docs](/cmd/goreleaser/) for details). +Some steps might be skipped with `--skip-foo`-like flags (check the +[command line docs](/cmd/goreleaser/) for details). If any of the previous steps fails, the next steps will not run.