mirror of
https://github.com/goreleaser/goreleaser.git
synced 2024-12-29 01:44:39 +02:00
docs: fix typos (#3054)
This commit is contained in:
parent
16f7e0d172
commit
38bc6b504e
@ -6,4 +6,4 @@ Only the last stable version at any given point.
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
Vulnerabilies can be disclosed via email to carlos@becker.software
|
||||
Vulnerabilities can be disclosed via email to carlos@becker.software
|
||||
|
@ -49,11 +49,11 @@ func newBuildCmd() *buildCmd {
|
||||
Short: "Builds the current project",
|
||||
Long: `The ` + "`goreleaser build`" + ` command is analogous to the ` + "`go build`" + ` command, in the sense it only builds binaries.
|
||||
|
||||
Its itented usage is, for example, within Makefiles to avoid setting up ldflags and etc in several places. That way, the GoReleaser config becomes the source of truth for how the binaries should be built.
|
||||
Its intended usage is, for example, within Makefiles to avoid setting up ldflags and etc in several places. That way, the GoReleaser config becomes the source of truth for how the binaries should be built.
|
||||
|
||||
It also allows you to generate a local build for your current machine only using the ` + "`--single-target`" + ` option, and specific build IDs using the ` + "`--id`" + ` option in case you have more than one.
|
||||
|
||||
When using ` + "`--single-target`" + `, the ` + "`GOOS`" + ` and ` + "`GOARCH`" + ` environment variables are used to determine the target, defaulting to the current's machine target if not set.
|
||||
When using ` + "`--single-target`" + `, the ` + "`GOOS`" + ` and ` + "`GOARCH`" + ` environment variables are used to determine the target, defaulting to the current machine target if not set.
|
||||
`,
|
||||
SilenceUsage: true,
|
||||
SilenceErrors: true,
|
||||
@ -87,7 +87,7 @@ When using ` + "`--single-target`" + `, the ` + "`GOOS`" + ` and ` + "`GOARCH`"
|
||||
cmd.Flags().BoolVar(&root.opts.singleTarget, "single-target", false, "Builds only for current GOOS and GOARCH")
|
||||
cmd.Flags().StringVar(&root.opts.id, "id", "", "Builds only the specified build id")
|
||||
cmd.Flags().BoolVar(&root.opts.deprecated, "deprecated", false, "Force print the deprecation message - tests only")
|
||||
cmd.Flags().StringVarP(&root.opts.output, "output", "o", "", "Copy the binary to the path after the build. Only taked into account when using --single-target and a single id (either with --id or if config only has one build)")
|
||||
cmd.Flags().StringVarP(&root.opts.output, "output", "o", "", "Copy the binary to the path after the build. Only taken into account when using --single-target and a single id (either with --id or if config only has one build)")
|
||||
_ = cmd.Flags().MarkHidden("deprecated")
|
||||
|
||||
root.cmd = cmd
|
||||
|
@ -35,7 +35,7 @@ steps:
|
||||
```
|
||||
|
||||
You need to pass the variable `GITHUB_TOKEN` in the Codefresh UI that
|
||||
contains credentials to your Github account or load it from
|
||||
contains credentials to your GitHub account or load it from
|
||||
[shared configuration](https://codefresh.io/docs/docs/configure-ci-cd-pipeline/shared-configuration/).
|
||||
You should also restrict this pipeline to run only on tags when you add
|
||||
[git triggers](https://codefresh.io/docs/docs/configure-ci-cd-pipeline/triggers/git-triggers/)
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
Below are some example GitLab CI jobs that use GoReleaser to release a project.
|
||||
|
||||
> If you are using private hosted or Enterprise version of Gitlab, please follow this [guide](/scm/gitlab/) before diving into the details.
|
||||
> If you are using private hosted or Enterprise version of GitLab, please follow this [guide](/scm/gitlab/) before diving into the details.
|
||||
|
||||
## Basic Releasing
|
||||
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Semaphore
|
||||
|
||||
In [Sempahore 2.0](https://semaphoreci.com) each project starts with the
|
||||
In [Semaphore 2.0](https://semaphoreci.com) each project starts with the
|
||||
default pipeline specified in `.semaphore/semaphore.yml`.
|
||||
|
||||
```yaml
|
||||
@ -82,4 +82,3 @@ data:
|
||||
|
||||
Check [Managing Secrets](https://docs.semaphoreci.com/article/51-secrets-yaml-reference)
|
||||
for more detailed documentation.
|
||||
|
||||
|
@ -6,11 +6,11 @@ Builds the current project
|
||||
|
||||
The `goreleaser build` command is analogous to the `go build` command, in the sense it only builds binaries.
|
||||
|
||||
Its itented usage is, for example, within Makefiles to avoid setting up ldflags and etc in several places. That way, the GoReleaser config becomes the source of truth for how the binaries should be built.
|
||||
Its intended usage is, for example, within Makefiles to avoid setting up ldflags and etc in several places. That way, the GoReleaser config becomes the source of truth for how the binaries should be built.
|
||||
|
||||
It also allows you to generate a local build for your current machine only using the `--single-target` option, and specific build IDs using the `--id` option in case you have more than one.
|
||||
|
||||
When using `--single-target`, the `GOOS` and `GOARCH` environment variables are used to determine the target, defaulting to the current's machine target if not set.
|
||||
When using `--single-target`, the `GOOS` and `GOARCH` environment variables are used to determine the target, defaulting to the current machine target if not set.
|
||||
|
||||
|
||||
```
|
||||
@ -23,7 +23,7 @@ goreleaser build [flags]
|
||||
-f, --config string Load configuration from file
|
||||
-h, --help help for build
|
||||
--id string Builds only the specified build id
|
||||
-o, --output string Copy the binary to the path after the build. Only taked into account when using --single-target and a single id (either with --id or if config only has one build)
|
||||
-o, --output string Copy the binary to the path after the build. Only taken into account when using --single-target and a single id (either with --id or if config only has one build)
|
||||
-p, --parallelism int Amount tasks to run concurrently (default: number of CPUs)
|
||||
--rm-dist Remove the dist folder before building
|
||||
--single-target Builds only for current GOOS and GOARCH
|
||||
|
@ -9,12 +9,12 @@ Tutorials made by the community.
|
||||
- [Fast and easy Go binaries delivery](https://carlosbecker.com/posts/goreleaser/)
|
||||
- [GitHub Action for release your Go projects as fast and easily as possible](https://dev.to/koddr/github-action-for-release-your-go-projects-as-fast-and-easily-as-possible-20a2)
|
||||
- [Go Release Automation with goreleaser + GitHub Actions](https://blog.toshima.ru/2019/10/20/go-release-automation-with-goreleaser.html)
|
||||
- [GoReleaser + Drone + Github: Tutorial](https://medium.com/@fallion/goreleaser-drone-github-tutorial-9a150103cac0)
|
||||
- [GoReleaser + Drone + GitHub: Tutorial](https://medium.com/@fallion/goreleaser-drone-github-tutorial-9a150103cac0)
|
||||
- [GoReleaser Docker Support](https://carlosbecker.com/posts/goreleaser-docker/)
|
||||
- [GoReleaser: build and push Snapcraft packages from TravisCI](https://carlosbecker.com/posts/goreleaser-snap-travis/)
|
||||
- [Multi-platform Docker images with GoReleaser and GitHub Actions](https://carlosbecker.com/posts/multi-platform-docker-images-goreleaser-gh-actions/)
|
||||
- [Multi-platform Docker images with GoReleaser, Podman and GitHub Actions](https://carlosbecker.com/posts/goreleaser-actions-podman/)
|
||||
- [Painless Github releases with Drone and GoReleaser](https://medium.com/@stepanvrany/painless-github-releases-with-drone-and-goreleaser-853bbbccd0c0)
|
||||
- [Painless GitHub releases with Drone and GoReleaser](https://medium.com/@stepanvrany/painless-github-releases-with-drone-and-goreleaser-853bbbccd0c0)
|
||||
- [Publishing dep/rpm packages with Goreleaser and Fury.io](https://netdevops.me/2021/building-and-publishing-deb/rpm-packages-with-goreleaser-and-gemfury/)
|
||||
- [Shipping Rust Binaries with GoReleaser](https://medium.com/@jondot/shipping-rust-binaries-with-goreleaser-d5aa42a46be0)
|
||||
- [Using GoReleaser includes feature](https://carlosbecker.com/posts/goreleaser-includes/)
|
||||
|
@ -77,7 +77,7 @@ These environment variables might be available in the fields that are templateab
|
||||
- `${artifactID}`: the ID of the artifact that will be signed
|
||||
- `${certificate}`: the certificate filename, if provided
|
||||
|
||||
[^1]: notice that the this might contain `/` characters, which depending on how you use it migth evaluate to actual paths within the filesystem. Use with care.
|
||||
[^1]: notice that the this might contain `/` characters, which depending on how you use it might evaluate to actual paths within the filesystem. Use with care.
|
||||
|
||||
|
||||
## Common usage example
|
||||
|
@ -33,7 +33,7 @@ furies:
|
||||
# Config is skipped if empty
|
||||
account: my-account
|
||||
|
||||
# Encironment variable name to get the push token from.
|
||||
# Environment variable name to get the push token from.
|
||||
# You might want to change it if you have multiple fury configurations for some reason.
|
||||
# Defaults to `FURY_TOKEN`.
|
||||
secret_name: MY_ACCOUNT_FURY_TOKEN
|
||||
@ -51,3 +51,4 @@ furies:
|
||||
```
|
||||
|
||||
[fury]: https://gemfury.com
|
||||
|
||||
|
@ -15,7 +15,7 @@ includes:
|
||||
- from_url:
|
||||
url: https://raw.githubusercontent.com/goreleaser/goreleaser/main/.goreleaser.yaml
|
||||
- from_url:
|
||||
url: caarlos0/goreleaserfiles/main/packages.yml # the https://raw.githubusercontent.com/ prefix may be ommited
|
||||
url: caarlos0/goreleaserfiles/main/packages.yml # the https://raw.githubusercontent.com/ prefix may be omitted
|
||||
- from_url:
|
||||
url: https://api.mycompany.com/configs/goreleaser.yaml
|
||||
headers:
|
||||
|
@ -33,7 +33,7 @@ You can also check if its a snapshot build inside a template with:
|
||||
Learn more about the [name template engine](/customization/templates/).
|
||||
|
||||
Note that the idea behind GoReleaser's snapshots is for local builds or to validate your build on the CI pipeline.
|
||||
Artifacts wont't be uploaded and will only be generated into the `dist` folder.
|
||||
Artifacts won't be uploaded and will only be generated into the `dist` folder.
|
||||
|
||||
!!! info "Maybe you are looking for something else?"
|
||||
- If just want to build the binaries, and no packages at all, check the [`goreleaser build` command](/cmd/goreleaser_build/);
|
||||
|
Loading…
Reference in New Issue
Block a user