1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2024-12-25 01:32:21 +02:00

feat: changing descriptions everywhere, more docs touches (#5368)

Using the new "Release engineering, simplified" phrasing everywhere.
This commit is contained in:
Carlos Alexandro Becker 2024-12-13 07:54:45 -03:00 committed by GitHub
parent 2a6fbc190a
commit 86262c1b85
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 26 additions and 20 deletions

View File

@ -118,7 +118,7 @@ dockers:
- "--label=io.artifacthub.package.logo-url=https://goreleaser.com/static/avatar.png" - "--label=io.artifacthub.package.logo-url=https://goreleaser.com/static/avatar.png"
- '--label=io.artifacthub.package.maintainers=[{"name":"Carlos Alexandro Becker","email":"carlos@carlosbecker.dev"}]' - '--label=io.artifacthub.package.maintainers=[{"name":"Carlos Alexandro Becker","email":"carlos@carlosbecker.dev"}]'
- "--label=io.artifacthub.package.license=MIT" - "--label=io.artifacthub.package.license=MIT"
- "--label=org.opencontainers.image.description=Deliver Go binaries as fast and easily as possible" - "--label=org.opencontainers.image.description=Release engineering, simplified"
- "--label=org.opencontainers.image.created={{.Date}}" - "--label=org.opencontainers.image.created={{.Date}}"
- "--label=org.opencontainers.image.name={{.ProjectName}}" - "--label=org.opencontainers.image.name={{.ProjectName}}"
- "--label=org.opencontainers.image.revision={{.FullCommit}}" - "--label=org.opencontainers.image.revision={{.FullCommit}}"
@ -138,7 +138,7 @@ dockers:
- "--label=io.artifacthub.package.logo-url=https://goreleaser.com/static/avatar.png" - "--label=io.artifacthub.package.logo-url=https://goreleaser.com/static/avatar.png"
- '--label=io.artifacthub.package.maintainers=[{"name":"Carlos Alexandro Becker","email":"carlos@carlosbecker.dev"}]' - '--label=io.artifacthub.package.maintainers=[{"name":"Carlos Alexandro Becker","email":"carlos@carlosbecker.dev"}]'
- "--label=io.artifacthub.package.license=MIT" - "--label=io.artifacthub.package.license=MIT"
- "--label=org.opencontainers.image.description=Deliver Go binaries as fast and easily as possible" - "--label=org.opencontainers.image.description=Release engineering, simplified"
- "--label=org.opencontainers.image.created={{.Date}}" - "--label=org.opencontainers.image.created={{.Date}}"
- "--label=org.opencontainers.image.name={{.ProjectName}}" - "--label=org.opencontainers.image.name={{.ProjectName}}"
- "--label=org.opencontainers.image.revision={{.FullCommit}}" - "--label=org.opencontainers.image.revision={{.FullCommit}}"
@ -219,7 +219,7 @@ brews:
directory: Formula directory: Formula
goarm: "7" goarm: "7"
homepage: https://goreleaser.com homepage: https://goreleaser.com
description: Deliver Go binaries as fast and easily as possible description: Release engineering, simplified
license: MIT license: MIT
test: | test: |
system "#{bin}/goreleaser -v" system "#{bin}/goreleaser -v"
@ -245,7 +245,7 @@ nix:
owner: goreleaser owner: goreleaser
name: nur name: nur
homepage: https://goreleaser.com homepage: https://goreleaser.com
description: Deliver Go binaries as fast and easily as possible description: Release engineering, simplified
path: pkgs/goreleaser/default.nix path: pkgs/goreleaser/default.nix
license: mit license: mit
extra_install: |- extra_install: |-
@ -257,7 +257,7 @@ winget:
publisher: goreleaser publisher: goreleaser
license: MIT license: MIT
homepage: https://goreleaser.com homepage: https://goreleaser.com
short_description: Deliver Go binaries as fast and easily as possible short_description: Release engineering, simplified
repository: repository:
owner: goreleaser owner: goreleaser
name: winget-pkgs name: winget-pkgs
@ -272,7 +272,7 @@ winget:
aurs: aurs:
- homepage: https://goreleaser.com - homepage: https://goreleaser.com
description: Deliver Go binaries as fast and easily as possible description: Release engineering, simplified
maintainers: maintainers:
- "Fernandez Ludovic <lfernandez dot dev at gmail dot com>" - "Fernandez Ludovic <lfernandez dot dev at gmail dot com>"
- "Carlos Alexandro Becker <carlos at becker dot software>" - "Carlos Alexandro Becker <carlos at becker dot software>"
@ -303,7 +303,7 @@ scoops:
name: scoop-bucket name: scoop-bucket
directory: bucket directory: bucket
homepage: https://goreleaser.com homepage: https://goreleaser.com
description: Deliver Go binaries as fast and easily as possible description: Release engineering, simplified
license: MIT license: MIT
nfpms: nfpms:
@ -311,9 +311,9 @@ nfpms:
id: packages id: packages
homepage: https://goreleaser.com homepage: https://goreleaser.com
description: |- description: |-
Deliver Go binaries as fast and easily as possible. Release engineering, simplified.
GoReleaser allows you to release easily build, package, publish and GoReleaser allows you to release easily build, package, publish, and
announce to several places at one go. announce to several places.
maintainer: Carlos Alexandro Becker <carlos@becker.software> maintainer: Carlos Alexandro Becker <carlos@becker.software>
license: MIT license: MIT
vendor: GoReleaser vendor: GoReleaser
@ -358,11 +358,10 @@ nfpms:
snapcrafts: snapcrafts:
- name_template: "{{ .ProjectName }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}" - name_template: "{{ .ProjectName }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}"
summary: Deliver Go binaries as fast and easily as possible summary: Release engineering, simplified
description: | description: |
GoReleaser builds Go binaries for several platforms, creates a GitHub GoReleaser allows you to release easily build, package, publish, and
release and then pushes a Homebrew formula to a repository. All that announce to several places.
wrapped in your favorite CI.
grade: stable grade: stable
confinement: classic confinement: classic
publish: true publish: true

View File

@ -1,7 +1,7 @@
<p align="center"> <p align="center">
<img alt="GoReleaser Logo" src="https://avatars2.githubusercontent.com/u/24697112?v=3&s=200" height="140" /> <img alt="GoReleaser Logo" src="https://avatars2.githubusercontent.com/u/24697112?v=3&s=200" height="140" />
<h3 align="center">GoReleaser</h3> <h3 align="center">GoReleaser</h3>
<p align="center">Deliver Go binaries as fast and easily as possible.</p> <p align="center">Release engineering, simplified.</p>
</p> </p>
--- ---

View File

@ -59,8 +59,8 @@ func newRootCmd(version goversion.Info, exit func(int)) *rootCmd {
} }
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "goreleaser", Use: "goreleaser",
Short: "Deliver Go binaries as fast and easily as possible", Short: "Release engineering, simplified",
Long: `GoReleaser is a release automation tool for Go projects. Long: `GoReleaser is a release automation tool.
Its goal is to simplify the build, release and publish steps while providing variant customization options for all steps. Its goal is to simplify the build, release and publish steps while providing variant customization options for all steps.
GoReleaser is built for CI tools, you only need to download and execute it in your build script. Of course, you can also install it locally if you wish. GoReleaser is built for CI tools, you only need to download and execute it in your build script. Of course, you can also install it locally if you wish.

View File

@ -49,7 +49,7 @@ var asciiArt string
func buildVersion(version, commit, date, builtBy, treeState string) goversion.Info { func buildVersion(version, commit, date, builtBy, treeState string) goversion.Info {
return goversion.GetVersionInfo( return goversion.GetVersionInfo(
goversion.WithAppDetails("goreleaser", "Deliver Go Binaries as fast and easily as possible", website), goversion.WithAppDetails("goreleaser", "Release engineering, simplified.", website),
goversion.WithASCIIName(asciiArt), goversion.WithASCIIName(asciiArt),
func(i *goversion.Info) { func(i *goversion.Info) {
if commit != "" { if commit != "" {

View File

@ -1,6 +1,8 @@
# Introduction # Introduction
Putting it simply, GoReleaser is a release automation tool for Go projects. Putting it simply, GoReleaser is a release automation tool.
It currently supports Go, Rust, and Zig.
## Why we made it? ## Why we made it?

View File

@ -106,6 +106,11 @@ Check your GitHub project's releases page!
</figure> </figure>
</a> </a>
## Other languages
Aside from the Go specifics, the process should be the same for the other
languages we support.
## Dry run ## Dry run
If you want to test everything before doing a release "for real", you can If you want to test everything before doing a release "for real", you can

View File

@ -1,6 +1,6 @@
site_name: GoReleaser site_name: GoReleaser
site_url: https://goreleaser.com site_url: https://goreleaser.com
site_description: Deliver Go binaries as fast and easily as possible site_description: Release engineering, simplified.
copyright: > copyright: >
Made with 🩶 by the Made with 🩶 by the
<a href="https://github.com/goreleaser/goreleaser/graphs/contributors" <a href="https://github.com/goreleaser/goreleaser/graphs/contributors"