github.com/joselitofilho/goreleaser@v0.155.1-0.20210123221854-e4891856c593/www/docs/deprecations.md (about) 1 --- 2 title: Deprecation notices 3 --- 4 5 This page is used to list deprecation notices across GoReleaser. 6 7 Deprecated options will be removed after ~6 months from the time they were 8 deprecated. 9 10 You can check your use of deprecated configurations by running: 11 12 ```sh 13 goreleaser check 14 ``` 15 16 ## Active deprecation notices 17 18 ### docker.builds 19 20 > since 2021-01-07 (v0.154.0) 21 22 `builds` is deprecated in favor of `ids`, since now it also allows to copy nfpm packages: 23 24 Change this: 25 26 === "Before" 27 ```yaml 28 dockers: 29 - 30 builds: ['a', 'b'] 31 ``` 32 33 === "After" 34 ```yaml 35 dockers: 36 - 37 ids: ['a', 'b'] 38 ``` 39 40 ### docker.binaries 41 42 > since 2021-01-07 (v0.154.0) 43 44 `binaries` is deprecated and now does nothing. 45 If you want to filter something out, use the `ids` property. 46 47 Change this: 48 49 === "Before" 50 ```yaml 51 dockers: 52 - 53 binaries: ['foo'] 54 ``` 55 56 === "After" 57 ```yaml 58 dockers: 59 - 60 ids: ['foo'] 61 ``` 62 63 ### nfpms.files 64 65 > since 2020-12-21 (v0.149.0) 66 67 `files` is deprecated in favor of `contents` (check [this page](https://goreleaser.com/customization/nfpm/) for more details): 68 69 Change this: 70 71 === "Before" 72 ```yaml 73 nfpms: 74 - 75 files: 76 foo: bar 77 ``` 78 79 === "After" 80 ```yaml 81 nfpms: 82 - 83 contents: 84 - src: foo 85 dst: bar 86 ``` 87 88 ### nfpms.config_files 89 90 > since 2020-12-21 (v0.149.0) 91 92 `config_files` is deprecated in favor of `contents` (check [this page](https://goreleaser.com/customization/nfpm/) for more details): 93 94 Change this: 95 96 === "Before" 97 ```yaml 98 nfpms: 99 - 100 config_files: 101 foo: bar 102 ``` 103 104 === "After" 105 ```yaml 106 nfpms: 107 - 108 contents: 109 - src: foo 110 dst: bar 111 type: config 112 ``` 113 114 ### nfpms.symlinks 115 116 > since 2020-12-21 (v0.149.0) 117 118 `symlinks` is deprecated in favor of `contents` (check [this page](https://goreleaser.com/customization/nfpm/) for more details): 119 120 Change this: 121 122 === "Before" 123 ```yaml 124 nfpms: 125 - 126 symlinks: 127 foo: bar 128 ``` 129 130 === "After" 131 ```yaml 132 nfpms: 133 - 134 contents: 135 - src: foo 136 dst: bar 137 type: symlink 138 ``` 139 140 ### nfpms.rpm.ghost_files 141 142 > since 2020-12-21 (v0.149.0) 143 144 `rpm.ghost_files` is deprecated in favor of `contents` (check [this page](https://goreleaser.com/customization/nfpm/) for more details): 145 146 Change this: 147 148 === "Before" 149 ```yaml 150 nfpms: 151 - 152 rpm: 153 ghost_files: 154 - foo 155 ``` 156 157 === "After" 158 ```yaml 159 nfpms: 160 - 161 contents: 162 - dst: bar 163 type: ghost 164 packager: rpm # optional 165 ``` 166 167 ### nfpms.rpm.config_noreplace_files 168 169 > since 2020-12-21 (v0.149.0) 170 171 `rpm.config_noreplace_files` is deprecated in favor of `contents` (check [this page](https://goreleaser.com/customization/nfpm/) for more details): 172 173 Change this: 174 175 === "Before" 176 ```yaml 177 nfpms: 178 - 179 rpm: 180 config_noreplace_files: 181 foo: bar 182 ``` 183 184 === "After" 185 ```yaml 186 nfpms: 187 - 188 contents: 189 - src: foo 190 dst: bar 191 type: config|noreplace 192 packager: rpm # optional 193 ``` 194 195 196 ### nfpms.deb.version_metadata 197 198 > since 2020-12-21 (v0.149.0) 199 200 `deb.version_metadata` is deprecated in favor of `version_metadata` (check [this page](https://goreleaser.com/customization/nfpm/) for more details): 201 202 Change this: 203 204 === "Before" 205 ```yaml 206 nfpms: 207 - 208 deb: 209 version_metadata: beta1 210 ``` 211 212 === "After" 213 ```yaml 214 nfpms: 215 - 216 version_metadata: beta1 217 ``` 218 219 <!-- 220 221 Template for new deprecations: 222 223 ### property 224 225 > since yyyy-mm-dd 226 227 Description. 228 229 === "Before" 230 231 ``` yaml 232 foo: bar 233 ``` 234 235 === "After" 236 ``` yaml 237 foo: bar 238 ``` 239 240 --> 241 242 ## Expired deprecation notices 243 244 The following options were deprecated in the past and were already removed. 245 246 ### brews.github 247 248 > since 2020-07-06 (v0.139.0), removed 2021-01-04 (v0.152.0) 249 250 GitHub section was deprecated in favour of `tap` which 251 reflects Homebrew's naming convention. GitHub will be picked 252 automatically when GitHub token is passed. 253 254 Change this: 255 256 === "Before" 257 ```yaml 258 brews: 259 - 260 github: 261 owner: goreleaser 262 name: homebrew-tap 263 ``` 264 265 === "After" 266 ```yaml 267 brews: 268 - 269 tap: 270 owner: goreleaser 271 name: homebrew-tap 272 ``` 273 274 ### brews.gitlab 275 276 > since 2020-07-06 (v0.139.0), removed 2021-01-04 (v0.152.0) 277 278 GitLab section was deprecated in favour of `tap` which 279 reflects Homebrew's naming convention. GitLab will be picked 280 automatically when GitLab token is passed. 281 282 Change this: 283 284 === "Before" 285 ```yaml 286 brews: 287 - 288 gitlab: 289 owner: goreleaser 290 name: homebrew-tap 291 ``` 292 293 === "After" 294 ```yaml 295 brews: 296 - 297 tap: 298 owner: goreleaser 299 name: homebrew-tap 300 ``` 301 302 ### puts 303 304 > since 2019-11-15, removed 2020-04-14 (v0.132.0) 305 306 The HTTP upload support was extended to also accept `POST` as a method, 307 so the name `puts` kind of lost its meaning. 308 309 === "Before" 310 311 ``` yaml 312 puts: 313 - ... 314 ``` 315 316 === "After" 317 ``` yaml 318 uploads: 319 - ... 320 ``` 321 322 Also note that secrets environment variable name prefixes have changed from 323 `PUT_` to `UPLOAD_`. 324 325 ### nfpms.name_template 326 327 > since 2019-11-15, removed 2020-04-14 (v0.132.0) 328 329 The `name_template` field was deprecated in favor of a more clear one, 330 `file_name_template`. 331 332 === "Before" 333 ``` yaml 334 nfpms: 335 - name_template: foo 336 ``` 337 338 339 === "After" 340 ``` yaml 341 nfpms: 342 - file_name_template: foo 343 ``` 344 345 ### blob 346 347 > since 2019-08-02, removed 2020-03-22 (v0.130.0) 348 349 Blob was deprecated in favor of its plural form. 350 It was already accepting multiple inputs, but its pluralized now so its more 351 clear. 352 353 === "Before" 354 ```yaml 355 blob: 356 # etc 357 ``` 358 359 === "After" 360 ```yaml 361 blobs: 362 # etc 363 ``` 364 365 ### sign 366 367 > since 2019-07-20, removed 2020-03-22 (v0.130.0) 368 369 Sign was deprecated in favor of its plural form. 370 371 === "Before" 372 ```yaml 373 sign: 374 # etc 375 ``` 376 377 === "After" 378 ```yaml 379 signs: 380 - 381 # etc 382 ``` 383 384 ### brew 385 386 > since 2019-06-09, removed 2020-01-26 (v0.125.0) 387 388 Brew was deprecated in favor of its plural form. 389 390 Change this: 391 392 === "Before" 393 ```yaml 394 brew: 395 # etc 396 ``` 397 398 === "After" 399 ```yaml 400 brews: 401 - 402 # etc 403 ``` 404 405 ### s3 406 407 > since 2019-06-09, removed 2020-01-07 (v0.125.0) 408 409 S3 was deprecated in favor of the new `blob`, which supports S3, Azure Blob and 410 GCS. 411 412 === "Before" 413 ```yaml 414 s3: 415 - 416 # etc 417 ``` 418 419 === "After" 420 ```yaml 421 blobs: 422 - 423 provider: s3 424 # etc 425 ``` 426 427 ACLs should be set on the bucket, the `acl` option does not exist anymore. 428 429 ### archive 430 431 > since 2019-04-16, removed 2019-12-27 (v0.124.0) 432 433 We now allow multiple archives, so the `archive` statement will be removed. 434 435 === "Before" 436 ```yaml 437 archive: 438 format: zip 439 ``` 440 441 === "After" 442 ```yaml 443 archives: 444 - id: foo 445 format: zip 446 ``` 447 448 ### snapcraft 449 450 > since 2019-05-27, removed 2019-12-27 (v0.124.0) 451 452 We now allow multiple Snapcraft configs, so the `snapcraft` statement will be removed. 453 454 === "Before" 455 ```yaml 456 snapcraft: 457 publish: true 458 # ... 459 ``` 460 461 === "After" 462 ```yaml 463 snapcrafts: 464 - 465 publish: true 466 # ... 467 ``` 468 469 ### nfpm 470 471 > since 2019-05-07, removed 2019-12-27 (v0.124.0) 472 473 We now allow multiple NFPM config, so the `nfpm` statement will be removed. 474 475 === "Before" 476 ```yaml 477 nfpm: 478 formats: 479 - deb 480 ``` 481 482 === "After" 483 ```yaml 484 nfpms: 485 - 486 formats: 487 - deb 488 ``` 489 490 ### docker.binary 491 492 > since 2018-10-01, removed 2019-08-02 (v0.114.0) 493 494 You can now create a Docker image with multiple binaries. 495 496 === "Before" 497 ```yaml 498 dockers: 499 - image: foo/bar 500 binary: foo 501 ``` 502 503 === "After" 504 ```yaml 505 dockers: 506 - image: foo/bar 507 binaries: 508 - foo 509 ``` 510 511 ### docker.image 512 513 > since 2018-10-20, removed 2019-08-02 (v0.114.0) 514 515 This property was deprecated in favor of more flexible `image_templates`. 516 The idea is to be able to define several images and tags using templates instead of just one image with tag templates. 517 This flexibility allows images to be pushed to multiple registries. 518 519 === "Before" 520 ```yaml 521 dockers: 522 - image: foo/bar 523 tag_templates: 524 - '{{ .Tag }}' 525 ``` 526 527 === "After" 528 ```yaml 529 dockers: 530 - image_templates: 531 - 'foo/bar:{{ .Tag }}' 532 ``` 533 534 ### docker.tag_templates 535 536 > since 2018-10-20, removed 2019-08-02 (v0.114.0) 537 538 This property was deprecated in favor of more flexible `image_templates`. 539 The idea is to be able to define several images and tags using templates instead of just one image with tag templates. 540 541 === "Before" 542 ```yaml 543 dockers: 544 - image: foo/bar 545 tag_templates: 546 - '{{ .Tag }}' 547 ``` 548 549 === "After" 550 ```yaml 551 dockers: 552 - image_templates: 553 - 'foo/bar:{{ .Tag }}' 554 ``` 555 556 ### git.short_hash 557 558 > since 2018-10-03, removed 2019-01-19 (v0.98.0) 559 560 This property was being used to tell GoReleaser to use short git hashes 561 instead of the full ones. This has been removed in favor of specific 562 template variables (`.FullCommit` and `.ShortCommit`). 563 564 === "Before" 565 ```yaml 566 git: 567 short_hash: true 568 569 fake: 570 foo_template: 'blah {{ .Commit }}' 571 ``` 572 573 === "After" 574 ```yaml 575 fake: 576 foo_template: 'blah {{ .ShortCommit }}' 577 ``` 578 579 ### fpm 580 581 > since 2018-02-17, removed 2017-08-15 (v0.83.0) 582 583 FPM is deprecated in favor of nfpm, which is a simpler alternative written 584 in Go. The objective is to remove the ruby dependency thus simplify the 585 CI/CD pipelines. 586 587 Just replace the `fpm` keyword by `nfpm` in your `.goreleaser.yml` file. 588 589 === "Before" 590 ```yaml 591 fpm: 592 # ... 593 ``` 594 595 === "After" 596 ```yaml 597 nfpm: 598 # ... 599 ``` 600 601 ### docker.tag_template 602 603 > since 2018-01-19, removed 2017-08-15 (v0.83.0) 604 605 This property was deprecated in favor of the pluralized `tag_templates`. 606 The idea is to be able to define several tags instead of just one. 607 608 === "Before" 609 ```yaml 610 dockers: 611 - image: foo/bar 612 tag_template: '{{ .Tag }}' 613 ``` 614 615 === "After" 616 ```yaml 617 dockers: 618 - image: foo/bar 619 tag_templates: 620 - '{{ .Tag }}' 621 ``` 622 623 ### docker.latest 624 625 > since 2018-01-19, removed 2017-08-15 (v0.83.0) 626 627 The `latest` field in Docker config is deprecated in favor of the newer 628 `tag_templates` field. 629 630 === "Before" 631 ```yaml 632 dockers: 633 - image: foo/bar 634 latest: true 635 ``` 636 637 === "After" 638 ```yaml 639 dockers: 640 - image: foo/bar 641 tag_templates: 642 - '{{ .Tag }}' 643 - latest 644 ```