1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-16 03:52:12 +02:00

docs: miscellaneous usage and wording improvements (#3152)

* Make sure to do required go mod init before continuing or goreleaser command fails.

* how the release might look like -> what the release might look like

* How does it look like -> What does it look like

* you must therefore -> you must

* Don't use GO111MODULES in example since it's so obsolete

* modules -> verifiable builds

* got you covered -> has you covered
This commit is contained in:
Randy Fay 2022-06-10 20:04:16 -06:00 committed by GitHub
parent f8e5bdac10
commit 176336f264
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 16 additions and 13 deletions

View File

@ -151,7 +151,7 @@ The following [permissions](https://docs.github.com/en/actions/reference/authent
`GITHUB_TOKEN` permissions [are limited to the repository][about-github-token] that contains your workflow.
If you need to push the homebrew tap to another repository, you must therefore create a custom
If you need to push the homebrew tap to another repository, you must create a custom
[Personal Access Token][pat] with `repo` permissions and [add it as a secret in the repository][secrets]. If you
create a secret named `GH_PAT`, the step will look like this:
@ -168,7 +168,7 @@ create a secret named `GH_PAT`, the step will look like this:
You can also read the [GitHub documentation](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) about it.
## How does it look like?
## What does it look like?
You can check [this example repository](https://github.com/goreleaser/example) for a real world example.

View File

@ -1,6 +1,6 @@
# Release a library
Maybe you don't want to actually release binaries, but just generate a changelog and whatnot for your Go libraries? GoReleaser got you covered!
Maybe you don't want to actually release binaries, but just generate a changelog and whatnot for your Go libraries? GoReleaser has you covered!
All you need is to add `skip: true` to the build config:

View File

@ -2,12 +2,11 @@
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:
If you have an environment variable named FOOBAR set to "on", your `.goreleaser.yaml` file could use it like this:
```yaml
# .goreleaser.yaml
env:
- GO111MODULE=on
- FOO={{ .Env.FOOBAR }}
- ENV_WITH_DEFAULT={{ if index .Env "ENV_WITH_DEFAULT" }}{{ .Env.ENV_WITH_DEFAULT }}{{ else }}default_value{{ end }}
before:
@ -17,8 +16,7 @@ builds:
- binary: program
```
This way, both `go mod tidy` and the underlying `go build` will have
`GO111MODULE` set to `on`.
This way, both `go mod tidy` and the underlying `go build` will have `FOO` set to `on`.
The root `env` section also accepts templates.

View File

@ -3,7 +3,7 @@
!!! success "GoReleaser Pro"
The monorepo support is a [GoReleaser Pro feature](/pro/).
If you want to use GoReleaser within a monorepo and use tag prefixes to mark "which tags belong to which sub project", GoReleaser got you covered.
If you want to use GoReleaser within a monorepo and use tag prefixes to mark "which tags belong to which sub project", GoReleaser has you covered.
## Premise

View File

@ -3,7 +3,7 @@
!!! success "GoReleaser Pro"
The nightly build feature is a [GoReleaser Pro feature](/pro/).
Whether if you need beta builds or a rolling-release system, the nightly builds feature gets you covered.
Whether if you need beta builds or a rolling-release system, the nightly builds feature will do it for you.
To enable it, you must use the `--nightly` flag in the [`goreleaser release` command](/cmd/goreleaser_release/).

View File

@ -1,4 +1,4 @@
# Go Modules
# Verifiable Builds
GoReleaser has support for creating verifiable builds.
A [verifiable build][vgo] is one that records enough information to be precise about exactly how to repeat it.

View File

@ -13,6 +13,11 @@ func main() {
}
```
Initialize modules with
```sh
go mod init main
```
Run the [init](/cmd/goreleaser_init/) command to create an example `.goreleaser.yaml` file:
```sh

View File

@ -36,7 +36,7 @@ If none are set, they default to GitHub's public URLs.
## Example release
Here's an example of how the release might look like:
Here's an example of what the release might look like:
<a href="https://github.com/goreleaser/example/releases">
<figure>

View File

@ -60,7 +60,7 @@ gitlab_urls:
## Example release
Here's an example of how the release might look like:
Here's an example of what the release might look like:
<a href="https://gitlab.com/goreleaser/example/-/releases">
<figure>

View File

@ -81,7 +81,7 @@ nav:
- customization/project.md
- Build:
- customization/build.md
- customization/gomod.md
- customization/verifiable_builds.md
- customization/monorepo.md
- customization/universalbinaries.md
- Packaging and Archiving: