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