docs: deprecations

Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com>

www/docs/deprecations.md

@@ -2,19 +2,20 @@
 title: Deprecation notices
 ---
 
-This page will be used to list deprecation notices across GoReleaser.
+This page is used to list deprecation notices across GoReleaser.
 
-Deprecate code will be removed after ~6 months from the time it was deprecated.
+Deprecated options will be removed after ~6 months from the time they were
+deprecated.
 
 You can check your use of deprecated configurations by running:
 
-```sh
+```console
 $ goreleaser check
 ```
 
 ## Active deprecation notices
 
-None.
+None at this time.
 
 <!--
 
@@ -26,21 +27,22 @@ Template for new deprecations:
 
 Description.
 
-Change this:
+=== "Before"
 
-```yaml
+    ``` yaml
-```
+    foo: bar
+    ```
 
-to this:
+=== "After"
-
+    ``` yaml
-```yaml
+    foo: bar
-```
+    ```
 
 -->
 
 ## Expired deprecation notices
 
-The following options were deprecated for ~6 months and are now fully removed.
+The following options were deprecated in the past and were already removed.
 
 ### puts
 
@@ -49,19 +51,18 @@ The following options were deprecated for ~6 months and are now fully removed.
 The HTTP upload support was extended to also accept `POST` as a method,
 so the name `puts` kind of lost its meaning.
 
-Change this:
+=== "Before"
 
-```yaml
+    ``` yaml
-puts:
+    puts:
-- ...
+    - ...
-```
+    ```
 
-to this:
+=== "After"
-
+    ``` yaml
-```yaml
+    uploads:
-uploads:
+    - ...
-- ...
+    ```
-```
 
 Also note that secrets environment variable name prefixes have changed from
 `PUT_` to `UPLOAD_`.
@@ -73,19 +74,18 @@ Also note that secrets environment variable name prefixes have changed from
 The `name_template` field was deprecated in favor of a more clear one,
 `file_name_template`.
 
-Change this:
+=== "Before"
+    ``` yaml
+    nfpms:
+    - name_template: foo
+    ```
 
-```yaml
-nfpms:
-  - name_template: foo
-```
 
-to this:
+=== "After"
-
+    ``` yaml
-```yaml
+    nfpms:
-nfpms:
+    - file_name_template: foo
-  - file_name_template: foo
+    ```
-```
 
 ### blob
 
@@ -95,19 +95,17 @@ Blob was deprecated in favor of its plural form.
 It was already accepting multiple inputs, but its pluralized now so its more
 clear.
 
-Change this:
+=== "Before"
+    ```yaml
+    blob:
+      # etc
+    ```
 
-```yaml
+=== "After"
-blob:
+    ```yaml
-  # etc
+    blobs:
-```
+      # etc
-
+    ```
-to this:
-
-```yaml
-blobs:
-  # etc
-```
 
 ### sign
 
@@ -115,20 +113,18 @@ blobs:
 
 Sign was deprecated in favor of its plural form.
 
-Change this:
+=== "Before"
+    ```yaml
+    sign:
+      # etc
+    ```
 
-```yaml
+=== "After"
-sign:
+    ```yaml
-  # etc
+    signs:
-```
+      -
-
+        # etc
-to this:
+    ```
-
-```yaml
-signs:
-  -
-    # etc
-```
 
 ### brew
 
@@ -138,18 +134,18 @@ Brew was deprecated in favor of its plural form.
 
 Change this:
 
-```yaml
+=== "Before"
-brew:
+    ```yaml
-  # etc
+    brew:
-```
+      # etc
+    ```
 
-to this:
+=== "After"
-
+    ```yaml
-```yaml
+    brews:
-brews:
+      -
-  -
+        # etc
-    # etc
+    ```
-```
 
 ### s3
 
@@ -158,22 +154,20 @@ brews:
 S3 was deprecated in favor of the new `blob`, which supports S3, Azure Blob and
 GCS.
 
-Change this:
+=== "Before"
+    ```yaml
+    s3:
+    -
+      # etc
+    ```
 
-```yaml
+=== "After"
-s3:
+    ```yaml
--
+    blobs:
-  # etc
+    -
-```
+      provider: s3
-
+      # etc
-to this:
+    ```
-
-```yaml
-blobs:
--
-  provider: s3
-  # etc
-```
 
 ACLs should be set on the bucket, the `acl` option does not exist anymore.
 
@@ -183,20 +177,18 @@ ACLs should be set on the bucket, the `acl` option does not exist anymore.
 
 We now allow multiple archives, so the `archive` statement will be removed.
 
-Change this:
+=== "Before"
+    ```yaml
+    archive:
+      format: zip
+    ```
 
-```yaml
+=== "After"
-archive:
+    ```yaml
-  format: zip
+    archives:
-```
+      - id: foo
-
+        format: zip
-to this:
+    ```
-
-```yaml
-archives:
-  - id: foo
-    format: zip
-```
 
 ### snapcraft
 
@@ -204,22 +196,20 @@ archives:
 
 We now allow multiple Snapcraft configs, so the `snapcraft` statement will be removed.
 
-Change this:
+=== "Before"
+    ```yaml
+    snapcraft:
+      publish: true
+      # ...
+    ```
 
-```yaml
+=== "After"
-snapcraft:
+    ```yaml
-  publish: true
+    snapcrafts:
-  # ...
+      -
-```
+        publish: true
-
+        # ...
-to this:
+    ```
-
-```yaml
-snapcrafts:
-  -
-    publish: true
-    # ...
-```
 
 ### nfpm
 
@@ -227,22 +217,20 @@ snapcrafts:
 
 We now allow multiple NFPM config, so the `nfpm` statement will be removed.
 
-Change this:
+=== "Before"
+    ```yaml
+    nfpm:
+      formats:
+        - deb
+    ```
 
-```yaml
+=== "After"
-nfpm:
+    ```yaml
-  formats:
+    nfpms:
-    - deb
+      -
-```
+        formats:
-
+          - deb
-to this:
+    ```
-
-```yaml
-nfpms:
-  -
-    formats:
-      - deb
-```
 
 ### docker.binary
 
@@ -250,22 +238,20 @@ nfpms:
 
 You can now create a Docker image with multiple binaries.
 
-Change this:
+=== "Before"
+    ```yaml
+    dockers:
+    - image: foo/bar
+      binary: foo
+    ```
 
-```yaml
+=== "After"
-dockers:
+    ```yaml
-- image: foo/bar
+    dockers:
-  binary: foo
+    - image: foo/bar
-```
+      binaries:
-
+      - foo
-to this:
+    ```
-
-```yaml
-dockers:
-- image: foo/bar
-  binaries:
-  - foo
-```
 
 ### docker.image
 
@@ -275,22 +261,20 @@ This property was deprecated in favor of more flexible `image_templates`.
 The idea is to be able to define several images and tags using templates instead of just one image with tag templates.
 This flexibility allows images to be pushed to multiple registries.
 
-Change this:
+=== "Before"
+    ```yaml
+    dockers:
+    - image: foo/bar
+      tag_templates:
+        - '{{ .Tag }}'
+    ```
 
-```yaml
+=== "After"
-dockers:
+    ```yaml
-- image: foo/bar
+    dockers:
-  tag_templates:
+    - image_templates:
-    - '{{ .Tag }}'
+        - 'foo/bar:{{ .Tag }}'
-```
+    ```
-
-to this:
-
-```yaml
-dockers:
-- image_templates:
-    - 'foo/bar:{{ .Tag }}'
-```
 
 ### docker.tag_templates
 
@@ -299,22 +283,20 @@ dockers:
 This property was deprecated in favor of more flexible `image_templates`.
 The idea is to be able to define several images and tags using templates instead of just one image with tag templates.
 
-Change this:
+=== "Before"
+    ```yaml
+    dockers:
+    - image: foo/bar
+      tag_templates:
+        - '{{ .Tag }}'
+    ```
 
-```yaml
+=== "After"
-dockers:
+    ```yaml
-- image: foo/bar
+    dockers:
-  tag_templates:
+    - image_templates:
-    - '{{ .Tag }}'
+        - 'foo/bar:{{ .Tag }}'
-```
+    ```
-
-to this:
-
-```yaml
-dockers:
-- image_templates:
-    - 'foo/bar:{{ .Tag }}'
-```
 
 ### git.short_hash
 
@@ -324,22 +306,20 @@ 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:
+=== "Before"
+    ```yaml
+    git:
+      short_hash: true
 
-```yaml
+    fake:
-git:
+      foo_template: 'blah {{ .Commit }}'
-  short_hash: true
+    ```
 
-fake:
+=== "After"
-  foo_template: 'blah {{ .Commit }}'
+    ```yaml
-```
+    fake:
-
+      foo_template: 'blah {{ .ShortCommit }}'
-to this:
+    ```
-
-```yaml
-fake:
-  foo_template: 'blah {{ .ShortCommit }}'
-```
 
 ### fpm
 
@@ -351,19 +331,17 @@ CI/CD pipelines.
 
 Just replace the `fpm` keyword by `nfpm` in your `goreleaser.yaml` file.
 
-Change this:
+=== "Before"
+    ```yaml
+    fpm:
+      # ...
+    ```
 
-```yaml
+=== "After"
-fpm:
+    ```yaml
-  # ...
+    nfpm:
-```
+      # ...
-
+    ```
-to this:
-
-```yaml
-nfpm:
-  # ...
-```
 
 ### docker.tag_template
 
@@ -372,22 +350,20 @@ nfpm:
 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:
+=== "Before"
+    ```yaml
+    dockers:
+    - image: foo/bar
+      tag_template: '{{ .Tag }}'
+    ```
 
-```yaml
+=== "After"
-dockers:
+    ```yaml
-- image: foo/bar
+    dockers:
-  tag_template: '{{ .Tag }}'
+    - image: foo/bar
-```
+      tag_templates:
-
+        - '{{ .Tag }}'
-to this:
+    ```
-
-```yaml
-dockers:
-- image: foo/bar
-  tag_templates:
-    - '{{ .Tag }}'
-```
 
 ### docker.latest
 
@@ -396,20 +372,18 @@ dockers:
 The `latest` field in Docker config is deprecated in favor of the newer
 `tag_templates` field.
 
-Change this:
+=== "Before"
+    ```yaml
+    dockers:
+    - image: foo/bar
+      latest: true
+    ```
 
-```yaml
+=== "After"
-dockers:
+    ```yaml
-- image: foo/bar
+    dockers:
-  latest: true
+    - image: foo/bar
-```
+      tag_templates:
-
+        - '{{ .Tag }}'
-to this:
+        - latest
-
+    ```
-```yaml
-dockers:
-- image: foo/bar
-  tag_templates:
-    - '{{ .Tag }}'
-    - latest
-```

www/mkdocs.yml

@@ -89,3 +89,5 @@ markdown_extensions:
   - meta
   - toc:
       permalink: true
+  - pymdownx.tabbed
+  - pymdownx.superfences