1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2024-12-31 01:53:50 +02:00

docs: improve wording

Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
This commit is contained in:
Carlos Alexandro Becker 2023-04-30 00:02:38 +00:00
parent 95b809dd13
commit cc2805b801
No known key found for this signature in database
GPG Key ID: E61E2F7DC14AB940
4 changed files with 14 additions and 13 deletions

View File

@ -108,7 +108,7 @@ jobs:
```
In this example a `Test` job is used to run `go test ./...` to first make sure that there're no failing tests. Only if
that job succeeds and the pipeline was triggered from a tag (because of the defined `condition`) Goreleaser will be run.
that job succeeds and the pipeline was triggered from a tag (because of the defined `condition`) GoReleaser will be run.
[goreleaser-extension]: https://marketplace.visualstudio.com/items?itemName=GoReleaser.goreleaser
[marketplace]: https://marketplace.visualstudio.com/azuredevops

View File

@ -5,7 +5,7 @@ Tutorials made by the community.
<!-- please, keep A-Z sorting -->
- [Creating debs and rpms with Go](https://carlosbecker.com/posts/nfpm/)
- [Cross compile with CGO and GoReleaser](https://medium.com/@robdefeo/cross-compile-with-cgo-and-goreleaser-6af884731222?source=friends_link&sk=baf6553fa48cb0e28ea3519615f02576)
- [Cross-compiling a CGO project using Goreleaser](https://www.jvt.me/posts/2023/02/24/goreleaser-cgo-cross-compile/)
- [Cross-compiling a CGO project using GoReleaser](https://www.jvt.me/posts/2023/02/24/goreleaser-cgo-cross-compile/)
- [Drop ballast... How I reduced the size of minectl 🗺](https://blog.ediri.io/drop-ballast-how-i-reduced-the-size-of-minectl)
- [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)
@ -16,7 +16,7 @@ Tutorials made by the community.
- [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)
- [Publishing dep/rpm packages with Goreleaser and Fury.io](https://netdevops.me/2021/building-and-publishing-debrpm-packages-with-goreleaser-and-gemfury/)
- [Publishing dep/rpm packages with GoReleaser and Fury.io](https://netdevops.me/2021/building-and-publishing-debrpm-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/)

View File

@ -1,16 +1,17 @@
# Webhook
# WebHooks
> Since: v1.3
Webhooks are a way to receive notifications. With this `Goreleaser` functionality, you can send events to any server
exposing a webhook.
WebHooks are a way to receive notifications.
With this GoReleaser functionality, you can send events to any server
exposing a WebHook.
If your endpoints are not secure, you can use following environment variables to configure them:
- BASIC_AUTH_HEADER_VALUE like `Basic <base64(username:password)>`
- BEARER_TOKEN_HEADER_VALUE like `Bearer <token>`
- `BASIC_AUTH_HEADER_VALUE` like `Basic <base64(username:password)>`
- `BEARER_TOKEN_HEADER_VALUE` like `Bearer <token>`
Add following to your `.goreleaser.yaml` config to enable the webhook functionality:
Add following to your `.goreleaser.yaml` configuration to enable the WebHook functionality:
```yaml
# .goreleaser.yaml

View File

@ -5,13 +5,13 @@
A Software Bill of Materials (SBOM) is a description of the components that make
up a software artifact.
Goreleaser can create one or more SBOMs for any artifacts generated by
Goreleaser.
GoReleaser can create one or more SBOMs for any artifacts generated by
GoReleaser.
## Usage
The artifact cataloging step can analyze one or more artifacts generated by
Goreleaser and output one or more SBOM files into the dist directory.
GoReleaser and output one or more SBOM files into the dist directory.
The default is configured to create an SBOM for each binary produced with
[Syft](https://github.com/anchore/syft). To enable artifact cataloging just add:
@ -111,6 +111,6 @@ templates:
## Limitations
Container images generated by Goreleaser are not available to be cataloged by
Container images generated by GoReleaser are not available to be cataloged by
the SBOM tool.