go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-24 04:16:27 +02:00
Code Issues Releases Activity
goreleaser/www/docs/customization/templatefiles.md

45 lines
856 B
Markdown
Raw Normal View History

docs: add missing file Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2023-03-01 09:42:12 -03:00
# Template Files
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
> Since v1.16 (pro)
docs: add missing file Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2023-03-01 09:42:12 -03:00
!!! success "GoReleaser 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
script.
All the templated files are uploaded to the release by default.
```yaml
# .goreleaser.yaml
template_files:
-
# ID of this particular file.
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
#
# Default: 'default'
docs: add missing file Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2023-03-01 09:42:12 -03:00
id: default
# Source path of the template file.
# Ignored if empty.
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
#
# Templates: allowed
docs: add missing file Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2023-03-01 09:42:12 -03:00
src: foo.tpl.sh
# Destination path of the file.
# Will be prefixed with the `dist` folder.
# Ignored if empty.
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
#
# Templates: allowed
docs: add missing file Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2023-03-01 09:42:12 -03:00
dst: foo.sh
# File mode.
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
#
# Default: 0655.
docs: add missing file Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2023-03-01 09:42:12 -03:00
mode: 0755
```
!!! tip
Learn more about the [name template engine](/customization/templates/).
Reference in New Issue Copy Permalink