mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-08 03:31:59 +02:00

Carlos Alexandro Becker d524d93086

docs: standarizing docs defaults, since, etc (#3898 )

- [x] if the default is the zero-value for the field, do not specify
- [ ] TODO: add a "how to read this docs" section somewhere explaining
that
- [x] if the change was introduced in a v1.x.0, say only v1.x
- [x] drop trail ending `.` from Since, Default, etc
- [x] wording: always use `Default: ` instead of `Defaults to` and
others
- [x] add a note to templateable fields
- [x] default value of a field, if its a string, always between single
quotes `'`

---------

Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>

2023-04-02 17:16:21 -03:00

856 B

Raw Blame History

Template Files

Since v1.16 (pro)

!!! success "GoReleaser Pro" Template Files is a GoReleaser Pro feature.

Template Files allow you to create custom files and/or scripts using GoReleaser's internal state and template variables, for example, an installer script.

All the templated files are uploaded to the release by default.

# .goreleaser.yaml
template_files:
-
  # ID of this particular file.
  #
  # Default: 'default'
  id: default

  # 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

  # File mode.
  #
  # Default: 0655.
  mode: 0755

!!! tip Learn more about the name template engine.

856 B Raw Blame History

Template Files

856 B

Raw Blame History