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

     1  # Krew Plugin Manifests
     2  
     3  After releasing to GitHub or GitLab, GoReleaser can generate and publish a _Krew
     4  Plugin Manifest_ into a repository that you have access to.
     5  
     6  Check their [website](https://krew.sigs.k8s.io) for more information.
     7  
     8  The `krews` section specifies how the plugins should be created:
     9  
    10  ```yaml
    11  # .goreleaser.yaml
    12  krews:
    13    -
    14      # Name of the recipe
    15      #
    16      # Default: ProjectName
    17      # Templates: allowed
    18      name: myproject
    19  
    20      # IDs of the archives to use.
    21      ids:
    22      - foo
    23      - bar
    24  
    25      # GOARM to specify which 32-bit arm version to use if there are multiple
    26      # versions from the build section. Krew plugin supports at this moment only
    27      # one 32-bit version.
    28      #
    29      # Default: 6
    30      goarm: 6
    31  
    32      # GOAMD64 to specify which amd64 version to use if there are multiple
    33      # versions from the build section.
    34      #
    35      # Default: 'v1'
    36      goamd64: v3
    37  
    38      # NOTE: make sure the url_template, the token and given repo (github or
    39      # gitlab) owner and name are from the same kind. We will probably unify this
    40      # in the next major version like it is done with scoop.
    41  
    42      # URL which is determined by the given Token (github or
    43      # gitlab)
    44      # Default:
    45      #   GitHub: 'https://github.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}'
    46      #   GitLab: 'https://gitlab.com/<repo_owner>/<repo_name>/-/releases/{{ .Tag }}/downloads/{{ .ArtifactName }}'
    47      #   Gitea: 'https://gitea.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}'
    48      # Templates: allowed
    49      url_template: "http://github.mycompany.com/foo/bar/releases/{{ .Tag }}/{{ .ArtifactName }}"
    50  
    51      # Git author used to commit to the repository.
    52      commit_author:
    53        name: goreleaserbot
    54        email: bot@goreleaser.com
    55  
    56      # The project name and current git tag are used in the format string.
    57      commit_msg_template: "Krew plugin update for {{ .ProjectName }} version {{ .Tag }}"
    58  
    59      # Your app's homepage.
    60      homepage: "https://example.com/"
    61  
    62      # Your app's description.
    63      # The usual guideline for this is to wrap the line at 80 chars.
    64      #
    65      # Templates: allowed
    66      description: "Software to create fast and easy drum rolls."
    67  
    68      # Your app's short description.
    69      # The usual guideline for this is to be at most 50 chars long.
    70      #
    71      # Templates: allowed
    72      short_description: "Software to create fast and easy drum rolls."
    73  
    74      # Caveats for the user of your binary.
    75      # The usual guideline for this is to wrap the line at 80 chars.
    76      caveats: "How to use this binary"
    77  
    78      # Setting this will prevent goreleaser to actually try to commit the updated
    79      # krew plugin - instead, the plugin file will be stored on the dist directory
    80      # only, leaving the responsibility of publishing it to the user.
    81      # If set to auto, the release will not be uploaded to the Krew plugin
    82      # in case there is an indicator for prerelease in the tag e.g. v1.0.0-rc1
    83      skip_upload: true
    84  
    85  {% include-markdown "../includes/repository.md" comments=false %}
    86  ```
    87  
    88  !!! tip
    89  
    90      Learn more about the [name template engine](/customization/templates/).
    91  
    92  ## Limitations
    93  
    94  - Only one binary per archive is allowed;
    95  - Binary releases (when `archives.format` is set to `binary`) are not allowed;
    96  - Only one `GOARM` build is allowed;
    97  
    98  {% include-markdown "../includes/prs.md" comments=false %}