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

     1  # Chocolatey Packages
     2  
     3  > Since: v1.13
     4  
     5  GoReleaser can also generate `nupkg` packages.
     6  [Chocolatey](http://chocolatey.org/) are packages based on `nupkg` format, that
     7  will let you publish your project directly to the Chocolatey Repository. From
     8  there it will be able to install locally or in Windows distributions.
     9  
    10  You can read more about it in the [chocolatey docs](https://docs.chocolatey.org/).
    11  
    12  Available options:
    13  
    14  ```yaml
    15  # .goreleaser.yaml
    16  chocolateys:
    17    - # Your app's package name.
    18      # The value may not contain spaces or character that are not valid for a URL.
    19      # If you want a good separator for words, use '-', not  '.'.
    20      #
    21      # Default: ProjectName
    22      name: foo
    23  
    24      # IDs of the archives to use.
    25      # Empty means all IDs.
    26      # Attention: archives must not be in the 'binary' format.
    27      ids:
    28        - foo
    29        - bar
    30  
    31      # Your app's owner.
    32      # It basically means you.
    33      owners: Drum Roll Inc
    34  
    35      # The app's title.
    36      # A human-friendly title of the package.
    37      #
    38      # Default: ProjectName
    39      title: Foo Bar
    40  
    41      # Your app's authors (probably you).
    42      authors: Drummer
    43  
    44      # Your app's project url.
    45      # It is a required field.
    46      project_url: https://example.com/
    47  
    48      # Which format to use.
    49      #
    50      # Valid options are:
    51      # - 'msi':     msi installers (requires the MSI pipe configured, Pro only)
    52      # - 'archive': archives (only if format is zip),
    53      #
    54      # Default: 'archive'
    55      # Since: v1.24 (pro)
    56      use: msi
    57  
    58      # URL which is determined by the given Token (github,
    59      # gitlab or gitea).
    60      #
    61      # Default: depends on the git remote
    62      # Templates: allowed
    63      url_template: "https://github.com/foo/bar/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
    64  
    65      # App's icon.
    66      icon_url: "https://rawcdn.githack.com/foo/bar/efbdc760-395b-43f1-bf69-ba25c374d473/icon.png"
    67  
    68      # Your app's copyright details.
    69      copyright: 2022 Drummer Roll Inc
    70  
    71      # App's license information url.
    72      license_url: https://github.com/foo/bar/blob/main/LICENSE
    73  
    74      # Your apps's require license acceptance:
    75      # Specify whether the client must prompt the consumer to accept the package
    76      # license before installing.
    77      require_license_acceptance: false
    78  
    79      # Your app's source url.
    80      project_source_url: https://github.com/foo/bar
    81  
    82      # Your app's documentation url.
    83      docs_url: https://github.com/foo/bar/blob/main/README.md
    84  
    85      # App's bugtracker url.
    86      bug_tracker_url: https://github.com/foo/barr/issues
    87  
    88      # Your app's tag list.
    89      tags: "foo bar baz"
    90  
    91      # Your app's summary:
    92      summary: Software to create fast and easy drum rolls.
    93  
    94      # This the description of your chocolatey package.
    95      # Supports markdown.
    96      description: |
    97        {{ .ProjectName }} installer package.
    98        Software to create fast and easy drum rolls.
    99  
   100      # Your app's release notes.
   101      # A description of the changes made in this release of the package.
   102      # Supports markdown. To prevent the need to continually update this field,
   103      # providing a URL to an external list of Release Notes is perfectly
   104      # acceptable.
   105      release_notes: "https://github.com/foo/bar/releases/tag/v{{ .Version }}"
   106  
   107      # App's dependencies
   108      # The version is not required.
   109      dependencies:
   110        - id: nfpm
   111          version: 2.20.0
   112  
   113      # The api key that should be used to push to the chocolatey repository.
   114      #
   115      # WARNING: do not expose your api key in the configuration file!
   116      api_key: "{{ .Env.CHOCOLATEY_API_KEY }}"
   117  
   118      # The source repository that will push the package to.
   119      source_repo: "https://push.chocolatey.org/"
   120  
   121      # Setting this will prevent goreleaser to actually try to push the package
   122      # to chocolatey repository, leaving the responsibility of publishing it to
   123      # the user.
   124      skip_publish: false
   125  
   126      # GOAMD64 to specify which amd64 version to use if there are multiple
   127      # versions from the build section.
   128      #
   129      # Default: 'v1'
   130      goamd64: v1
   131  ```
   132  
   133  !!! tip
   134  
   135      Learn more about the [name template engine](/customization/templates/).
   136  
   137  !!! note
   138  
   139      GoReleaser will not install `chocolatey`/`choco` nor any of its dependencies
   140      for you.