github.com/goreleaser/goreleaser@v1.25.1/www/docs/includes/repository.md (about)

     1      # Repository to push the generated files to.
     2      repository:
     3        # Repository owner.
     4        #
     5        # Templates: allowed
     6        owner: caarlos0
     7  
     8        # Repository name.
     9        #
    10        # Templates: allowed
    11        name: my-repo
    12  
    13        # Optionally a branch can be provided.
    14        #
    15        # Default: default repository branch
    16        # Templates: allowed
    17        branch: main
    18  
    19        # Optionally a token can be provided, if it differs from the token
    20        # provided to GoReleaser
    21        # Templates: allowed
    22        token: "{{ .Env.GITHUB_PERSONAL_AUTH_TOKEN }}"
    23  
    24        # Sets up pull request creation instead of just pushing to the given branch.
    25        # Make sure the 'branch' property is different from base before enabling
    26        # it.
    27        #
    28        # Since: v1.17
    29        pull_request:
    30          # Whether to enable it or not.
    31          enabled: true
    32  
    33          # Whether to open the PR as a draft or not.
    34          #
    35          # Since: v1.19
    36          draft: true
    37  
    38          # If the pull request template has checkboxes, enabling this will
    39          # check all of them.
    40          #
    41          # This feature is only available in GoReleaser Pro.
    42          # Since: v1.20 (pro)
    43          check_boxes: true
    44  
    45          # Base can also be another repository, in which case the owner and name
    46          # above will be used as HEAD, allowing cross-repository pull requests.
    47          #
    48          # Since: v1.19
    49          base:
    50            owner: goreleaser
    51            name: my-repo
    52            branch: main
    53  
    54        # Clone, create the file, commit and push, to a regular Git repository.
    55        #
    56        # Notice that this will only have any effect if the given URL is not
    57        # empty.
    58        #
    59        # Since: v1.18
    60        git:
    61          # The Git URL to push.
    62          #
    63          # Templates: allowed
    64          url: 'ssh://git@myserver.com:repo.git'
    65  
    66          # The SSH private key that should be used to commit to the Git
    67          # repository.
    68          # This can either be a path or the key contents.
    69          #
    70          # IMPORTANT: the key must not be password-protected.
    71          #
    72          # WARNING: do not expose your private key in the configuration file!
    73          #
    74          # Templates: allowed
    75          private_key: '{{ .Env.PRIVATE_KEY_PATH }}'
    76  
    77          # The value to be passed to `GIT_SSH_COMMAND`.
    78          # This is mainly used to specify the SSH private key used to pull/push
    79          # to the Git URL.
    80          #
    81          # Default: 'ssh -i {{ .KeyPath }} -o StrictHostKeyChecking=accept-new -F /dev/null'
    82          # Templates: allowed
    83          ssh_command: 'ssh -i {{ .Env.KEY }} -o SomeOption=yes'