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