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

     1  # GitHub
     2  
     3  ## API Token
     4  
     5  GoReleaser requires an API token with the `repo` scope selected to deploy the
     6  artifacts to GitHub. You can create one
     7  [here](https://github.com/settings/tokens/new).
     8  
     9  This token should be added to the environment variables as `GITHUB_TOKEN`.
    10  
    11  Alternatively, you can provide the GitHub token in a file. GoReleaser will check
    12  `~/.config/goreleaser/github_token` by default, but you can change that in the
    13  `.goreleaser.yaml` file:
    14  
    15  ```yaml
    16  # .goreleaser.yaml
    17  env_files:
    18    github_token: ~/.path/to/my/github_token
    19  ```
    20  
    21  Note that the environment variable will be used if available, regardless of the
    22  `github_token` file.
    23  
    24  ## GitHub Enterprise
    25  
    26  You can use GoReleaser with GitHub Enterprise by providing its URLs in the
    27  `.goreleaser.yaml` configuration file. This takes a normal string, or a template
    28  value.
    29  
    30  ```yaml
    31  # .goreleaser.yaml
    32  github_urls:
    33    api: https://git.company.com/api/v3/
    34    upload: https://git.company.com/api/uploads/
    35    download: https://git.company.com/
    36    # set to true if you use a self-signed certificate
    37    skip_tls_verify: false
    38  ```
    39  
    40  If none are set, they default to GitHub's public URLs.
    41  
    42  ## Example release
    43  
    44  Here's an example of what the release might look like:
    45  
    46  <a href="https://github.com/goreleaser/example/releases">
    47    <figure>
    48      <img src="https://img.carlosbecker.dev/goreleaser-github.png"/>
    49      <figcaption>Example release on GitHub.</figcaption>
    50    </figure>
    51  </a>