1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-11-29 23:07:42 +02:00

docs: update

This commit is contained in:
Carlos Alexandro Becker
2024-03-03 10:53:17 -03:00
parent e0db6ac7fa
commit 1f39bddcb3
7 changed files with 118 additions and 22 deletions

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)
!!! 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
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
# .goreleaser.yaml
template_files:
-
# ID of this particular file.
#
# Default: 'default'
id: default
- # ID of this particular file.
#
# Default: 'default'
id: default
# Source path of the template file.
# Ignored if empty.
#
# Templates: allowed
src: foo.tpl.sh
# Source path of the template file.
# Ignored if empty.
#
# Templates: allowed
src: foo.tpl.sh
# Destination path of the file.
# Will be prefixed with the `dist` folder.
# Ignored if empty.
#
# Templates: allowed
dst: foo.sh
# Destination path of the file.
# Will be prefixed with the `dist` folder.
# Ignored if empty.
#
# Templates: allowed
dst: foo.sh
# File mode.
#
# Default: 0655.
mode: 0755
# File mode.
#
# Default: 0655.
mode: 0755
```
!!! tip
Learn more about the [name template engine](/customization/templates/).