go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-02-01 13:07:49 +02:00
Code Issues Releases Activity

docs: update grammar in markdown (#2846)

Browse Source
This commit is contained in:
Khris Richardson 2022-01-23 11:29:31 -08:00 committed by GitHub
parent acddce5777
commit 7a2fc167c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
www/docs/how-it-works.md
View File

@ -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.