github.com/goreleaser/goreleaser@v1.25.1/www/docs/customization/dockerhub.md (about)

     1  # DockerHub
     2  
     3  > Since v1.25 (pro)
     4  
     5  !!! success "GoReleaser Pro"
     6  
     7      DockerHub is a [GoReleaser Pro feature](/pro/).
     8  
     9  DockerHub allows you to set an image description and a full description.
    10  However, this is not possible via `docker push`.
    11  This pipe allows you to configure these fields and ensures they are set when
    12  publishing your releases.
    13  
    14  You also have plenty of customization options:
    15  
    16  ```yaml
    17  # goreleaser.yaml
    18  
    19  dockerhub:
    20    - # Your hub.docker.com username. Must have 'editor' permissions
    21      #
    22      # Default: "{{ .Env.DOCKER_USERNAME }}"
    23      # Templates: allowed
    24      username: "john.doe"
    25  
    26      # Environment variable name to get the push token from.
    27      # You might want to change it if you have multiple dockerhub configurations.
    28      #
    29      # Templates: allowed
    30      # Default: "DOCKER_PASSWORD"
    31      secret_name: DOCKER_TOKEN
    32  
    33      # Images to apply the description and/or full description to.
    34      #
    35      # Templates: allowed
    36      images:
    37        - goreleaser/goreleaser
    38        - goreleaser/goreleaser-pro
    39  
    40      # Disables the configuration feature in some conditions, for instance, when
    41      # publishing patch releases.
    42      # Any value different of 'true' will be considered 'false'.
    43      #
    44      # Templates: allowed
    45      disable: "{{gt .Patch 0}}"
    46  
    47      # The short description of the image.
    48      #
    49      # Templates: allowed
    50      description: A short description
    51  
    52      # The full description of the image.
    53      #
    54      # It can be a string directly, or you can use `from_url` or `from_file` to
    55      # source it from somewhere else.
    56      #
    57      # Templates: allowed
    58      full_description:
    59        # Loads from an URL.
    60        from_url:
    61          # Templates: allowed
    62          url: https://foo.bar/README.md
    63          headers:
    64            x-api-token: "${MYCOMPANY_TOKEN}"
    65  
    66        # Loads from a local file.
    67        # Overrides `from_url`.
    68        from_file:
    69          # Templates: allowed
    70          path: ./README.md
    71  ```
    72  
    73  !!! tip
    74  
    75      Learn more about the [name template engine](/customization/templates/).