Skip to content
🎉 GoReleaser v2.15 is out! with Flatpak, SRPM, and more!
Repository
# Repository to push the generated files to.
repository:
  # Repository owner.
  #
  # Templates: allowed.
  owner: caarlos0

  # Repository name.
  #
  # Templates: allowed.
  name: my-repo

  # Optionally a branch can be provided.
  #
  # Default: default repository branch.
  # Templates: allowed.
  branch: main

  # Optionally a token can be provided, if it differs from the token
  # provided to GoReleaser
  #
  # Templates: allowed.
  token: "{{ .Env.GITHUB_PERSONAL_AUTH_TOKEN }}"

  # Optionally specify if this is a token from another SCM, allowing to
  # cross-publish.
  #
  # Only taken into account if `token` is set.
  #
  # Valid options:
  # - 'github'
  # - 'gitlab'
  # - 'gitea'
  #
  # This feature is only available in GoReleaser Pro.
  token_type: "github"

  # Sets up pull request creation instead of just pushing to the given branch.
  # Make sure the 'branch' property is different from base before enabling
  # it.
  #
  # This might require a personal access token.
  pull_request:
    # Whether to enable it or not.
    enabled: true

    # Whether to open the PR as a draft or not.
    draft: true

    # If the pull request template has checkboxes, enabling this will
    # check all of them.
    #
    # This feature is only available in GoReleaser Pro, and when the pull
    # request is being opened on GitHub.
    check_boxes: true

    # Allows to set a body for the pull request.
    # If the repository has a pull request template, it will be appended to
    # this.
    #
    # 
Since v2.12
body: | cc/ @foobar # Base can also be another repository, in which case the owner and name # above will be used as HEAD, allowing cross-repository pull requests. base: owner: goreleaser name: my-repo branch: main # Clone, create the file, commit and push, to a regular Git repository. # # Notice that this will only have any effect if the given URL is not # empty. git: # The Git URL to push. # # Templates: allowed. url: 'ssh://[email protected]:repo.git' # The SSH private key that should be used to commit to the Git # repository. # This can either be a path or the key contents. # # IMPORTANT: the key must not be password-protected. # # WARNING: do not expose your private key in the configuration file! # # Templates: allowed. private_key: '{{ .Env.PRIVATE_KEY_PATH }}' # The value to be passed to `GIT_SSH_COMMAND`. # This is mainly used to specify the SSH private key used to pull/push # to the Git URL. # # Default: 'ssh -i {{ .KeyPath }} -o StrictHostKeyChecking=accept-new -F /dev/null'. # Templates: allowed. ssh_command: 'ssh -i {{ .Env.KEY }} -o SomeOption=yes' # Git author used to commit to the repository. # #
Since v2.11
# Default: inferred from global metadata.
Since v2.12
commit_author: # Git author name. # # Templates: allowed. name: goreleaserbot # Git author email. # # Templates: allowed. email: [email protected] # Git commit signing configuration. # Only useful if repository is of type 'git'. # #
Since v2.11
signing: # Enable commit signing. enabled: true # The signing key to use. # Can be a key ID, fingerprint, email address, or path to a key file. # # Templates: allowed. key: "{{ .Env.GPG_SIGNING_KEY }}" # The GPG program to use for signing. # # Templates: allowed. program: gpg2 # The signature format to use. # # Valid options: openpgp, x509, ssh. # Default: openpgp. format: openpgp
Last updated on