1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-02-01 13:07:49 +02:00

docs: update

This commit is contained in:
Carlos Alexandro Becker 2024-03-03 10:53:17 -03:00
parent e0db6ac7fa
commit 1f39bddcb3
No known key found for this signature in database
7 changed files with 118 additions and 22 deletions

View File

@ -35,4 +35,5 @@ Check out our website for more information, examples and documentation: https://
* [goreleaser jsonschema](/cmd/goreleaser_jsonschema/) - outputs goreleaser's JSON schema * [goreleaser jsonschema](/cmd/goreleaser_jsonschema/) - outputs goreleaser's JSON schema
* [goreleaser publish](/cmd/goreleaser_publish/) - Publishes a previously prepared release * [goreleaser publish](/cmd/goreleaser_publish/) - Publishes a previously prepared release
* [goreleaser release](/cmd/goreleaser_release/) - Releases the current project * [goreleaser release](/cmd/goreleaser_release/) - Releases the current project
* [goreleaser verify-license](/cmd/goreleaser_verify-license/) - Verify if the given license is valid

View File

@ -26,7 +26,7 @@ goreleaser release [flags]
--release-notes string Load custom release notes from a markdown file (will skip GoReleaser changelog generation) --release-notes string Load custom release notes from a markdown file (will skip GoReleaser changelog generation)
--release-notes-tmpl string Load custom release notes from a templated markdown file (overrides --release-notes) --release-notes-tmpl string Load custom release notes from a templated markdown file (overrides --release-notes)
--single-target Builds only for current GOOS and GOARCH, regardless of what's set in the configuration file (implies --skip-publish) (Pro only) --single-target Builds only for current GOOS and GOARCH, regardless of what's set in the configuration file (implies --skip-publish) (Pro only)
--skip strings Skip the given options (valid options are: after, announce, aur, before, chocolatey, dmg, docker, fury, homebrew, ko, msi, nfpm, nix, publish, sbom, scoop, sign, snapcraft, validate, winget) --skip strings Skip the given options (valid options are: after, announce, aur, before, chocolatey, dmg, docker, dockerhub, fury, homebrew, ko, msi, nfpm, nix, publish, sbom, scoop, sign, snapcraft, validate, winget)
--snapshot Generate an unversioned snapshot release, skipping all validations and without publishing any artifacts (implies --skip=announce,publish,validate) --snapshot Generate an unversioned snapshot release, skipping all validations and without publishing any artifacts (implies --skip=announce,publish,validate)
--split Split the build so it can be merged and published later (implies --prepare) (Pro only) --split Split the build so it can be merged and published later (implies --prepare) (Pro only)
--timeout duration Timeout to the entire release process (default 30m0s) --timeout duration Timeout to the entire release process (default 30m0s)

View File

@ -0,0 +1,26 @@
# goreleaser verify-license
Verify if the given license is valid
```
goreleaser verify-license [flags]
```
## Options
```
-h, --help help for verify-license
-k, --key string GoReleaser Pro license key [$GORELEASER_KEY] (Pro only)
```
## Options inherited from parent commands
```
--debug Enable verbose mode (deprecated)
--verbose Enable verbose mode
```
## See also
* [goreleaser](/cmd/goreleaser/) - Deliver Go binaries as fast and easily as possible

View File

@ -0,0 +1,67 @@
# DockerHub
> Since v1.25 (pro)
!!! success "GoReleaser Pro"
DockerHub is a [GoReleaser Pro feature](/pro/).
DockerHub allows you to set an image description, and a full description.
However, this is not possible via `docker push`.
This pipe allows you to configure these fields and ensures they are set when
publishing your releases.
You can also have plenty of customization options:
```yaml
# goreleaser.yaml
dockerhubs:
- # Your docker.io username.
#
# Templates: allowed
usernme: "{{ .Env.DOCKER_USERNAME }}"
# Disables the configuration feature in some conditions, for instance, when
# publishing patch releases.
# Any value different of 'true' will be considered 'false'.
#
# Templates: allowed
disable: "{{gt .Patch 0}}"
# Environment variable name to get the push token from.
# You might want to change it if you have multiple dockerhub configurations.
#
# Templates: allowed
# Default: 'DOCKER_PASSWORD'
secret_name: MY_ACCOUNT_DOCKER_PASSWORD
# The short description of the image.
#
# Templates: allowed
description: A short description
# The full description of the image.
#
# It can be a string directly, or you can use `from_url` or `from_file` to
# source it from somewhere else.
#
# Templates: allowed
full_description:
# Loads from an URL.
from_url:
# Templates: allowed
url: https://foo.bar/README.md
headers:
x-api-token: "${MYCOMPANY_TOKEN}"
# Loads from a local file.
# Overrides `from_url`.
from_file:
# Templates: allowed
path: ./README.md
```
!!! tip
Learn more about the [name template engine](/customization/templates/).

View File

@ -3,8 +3,8 @@
> Since v1.16 (pro) > Since v1.16 (pro)
!!! success "GoReleaser Pro" !!! success "GoReleaser Pro"
Template Files is a [GoReleaser Pro feature](/pro/).
Template Files is a [GoReleaser Pro feature](/pro/).
Template Files allow you to create custom files and/or scripts using Template Files allow you to create custom files and/or scripts using
GoReleaser's internal state and template variables, for example, an installer GoReleaser's internal state and template variables, for example, an installer
@ -15,30 +15,30 @@ All the templated files are uploaded to the release by default.
```yaml ```yaml
# .goreleaser.yaml # .goreleaser.yaml
template_files: template_files:
- - # ID of this particular file.
# ID of this particular file. #
# # Default: 'default'
# Default: 'default' id: default
id: default
# Source path of the template file. # Source path of the template file.
# Ignored if empty. # Ignored if empty.
# #
# Templates: allowed # Templates: allowed
src: foo.tpl.sh src: foo.tpl.sh
# Destination path of the file. # Destination path of the file.
# Will be prefixed with the `dist` folder. # Will be prefixed with the `dist` folder.
# Ignored if empty. # Ignored if empty.
# #
# Templates: allowed # Templates: allowed
dst: foo.sh dst: foo.sh
# File mode. # File mode.
# #
# Default: 0655. # Default: 0655.
mode: 0755 mode: 0755
``` ```
!!! tip !!! tip
Learn more about the [name template engine](/customization/templates/). Learn more about the [name template engine](/customization/templates/).

View File

@ -3,6 +3,7 @@
GoReleaser Pro is a paid, closed-source GoReleaser distribution with some GoReleaser Pro is a paid, closed-source GoReleaser distribution with some
additional features: additional features:
- [x] Keep [DockerHub image descriptions up to date](/customization/dockerhub);
- [x] Create [macOS disk images (DMGs)](/customization/dmg); - [x] Create [macOS disk images (DMGs)](/customization/dmg);
- [x] Create [Windows installers](/customization/msi); - [x] Create [Windows installers](/customization/msi);
- [x] Use `goreleaser release --single-target` to build the whole pipeline for a - [x] Use `goreleaser release --single-target` to build the whole pipeline for a

View File

@ -130,6 +130,7 @@ nav:
- customization/nightlies.md - customization/nightlies.md
- customization/blob.md - customization/blob.md
- customization/fury.md - customization/fury.md
- customization/dockerhub.md
- customization/homebrew.md - customization/homebrew.md
- customization/nix.md - customization/nix.md
- customization/winget.md - customization/winget.md