1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-10 03:47:03 +02:00
goreleaser/www/content/deprecations.md

145 lines
2.0 KiB
Markdown
Raw Normal View History

---
title: Deprecation notices
menu: true
weight: 500
hideFromIndex: true
---
This page will be used to list deprecation notices accross GoReleaser.
2018-08-15 14:56:49 +02:00
Deprecate code will be removed after ~6 months from the time it was deprecated.
# Active deprecation notices
No active deprecation notices at this time.
<!--
Template for new deprecations:
## property
> since yyyy-mm-dd
Description.
Change this:
```yaml
```
to this:
```yaml
```
-->
2018-10-03 22:51:27 +02:00
## git.short_hash
> since 2018-10-03
This property was being used to tell GoReleaser to use short git hashes
instead of the full ones. This has been removed in favor of specific
template variables (`.FullCommit` and `.ShortCommit`).
Change this:
```yaml
git:
short_hash: true
fake:
foo_template: 'blah {{ .Commit }}'
```
to this:
```yaml
fake:
foo_template: 'blah {{ .ShortCommit }}'
```
2018-08-15 14:56:49 +02:00
# Expired deprecation notices
2018-08-15 15:51:47 +02:00
The following options were deprecated for ~6 months and are now unsupported.
## fpm
> since 2018-02-17
2018-08-15 15:51:47 +02:00
>
2018-08-15 14:56:49 +02:00
> removed 2017-08-15
FPM is deprecated in favor of nfpm, which is a simpler alternative written
in Go. The objective is to remove the ruby dependency thus simplify the
CI/CD pipelines.
Just replace the `fpm` keyword by `nfpm` in your `goreleaser.yaml` file.
Change this:
```yaml
fpm:
# ...
```
to this:
```yaml
nfpm:
# ...
```
## docker.tag_template
> since 2018-01-19
2018-08-15 15:51:47 +02:00
>
> removed 2017-08-15
This property was deprecated in favor of the pluralized `tag_templates`.
The idea is to be able to define several tags instead of just one.
Change this:
```yaml
dockers:
- image: foo/bar
tag_template: '{{ .Tag }}'
```
to this:
```yaml
dockers:
- image: foo/bar
tag_templates:
- '{{ .Tag }}'
```
## docker.latest
> since 2018-01-19
2018-08-15 15:51:47 +02:00
>
> removed 2017-08-15
The `latest` field in Docker config is deprecated in favor of the newer
`tag_templates` field.
Change this:
```yaml
dockers:
- image: foo/bar
latest: true
```
to this:
```yaml
dockers:
- image: foo/bar
tag_templates:
- '{{ .Tag }}'
- latest
```