mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-10 03:47:03 +02:00

docs: update docs to mention gitlab protected vars (#3528 )

add warning about gitlab-ci protected variables for both CI/gitlab and
SCM/gitlab.
Failing to run the pipelines on a protected ref will cause goreleaser to
fail with `401: unauthorized` if for example, GITLAB_TOKEN is a
protected variable and the CI Job is running on a tag that is not
protected.

<!--

Hi, thanks for contributing!

Please make sure you read our CONTRIBUTING guide.

Also, add tests and the respective documentation changes as well.

-->


<!-- If applied, this commit will... -->

Add a warning about Gitlab CI and protected variables

<!-- Why is this change being made? -->

To prevent future users from running into issues with protected
variables.

<!-- # Provide links to any relevant tickets, URLs or other resources
-->

[Discord
Convo](https://discord.com/channels/890434333251362866/890434334803247126/1038130560293412955)

2022-11-04 16:04:19 -03:00

3.1 KiB

Raw Blame History

GitLab

API Token

GoReleaser requires an API token with the api scope selected to deploy the artifacts to GitLab. That token can either be a Personal, or a Project one.

This token should be added to the environment variables as GITLAB_TOKEN.

Alternatively, you can provide the GitLab token in a file. GoReleaser will check ~/.config/goreleaser/gitlab_token by default, but you can change that in the .goreleaser.yaml file:

# .goreleaser.yaml
env_files:
  gitlab_token: ~/.path/to/my/gitlab_token

!!! warning If you use a project access token, make sure to set use_package_registry to true as well, otherwise it might not work.

!!! warning If you are using a protected variable to store any of the values needed by goreleaser, ensure that you are protecting the tags as CI jobs in Gitlab only may access protected variables if the job is run for protected refs (branches, tags).

GitLab Enterprise or private hosted

You can use GoReleaser with GitLab Enterprise by providing its URLs in the .goreleaser.yml configuration file. This takes a normal string, or a template value.

# .goreleaser.yml
gitlab_urls:
  api: https://gitlab.mycompany.com/api/v4/
  download: https://gitlab.company.com

  # set to true if you use a self-signed certificate
  skip_tls_verify: false

  # set to true if you want to upload to the Package Registry rather than attachments
  # Only works with GitLab 13.5+
  # Since: v1.3.
  use_package_registry: false

  # Set this if you set GITLAB_TOKEN to the value of CI_JOB_TOKEN.
  # Default: false
  # Since: v1.11.
  use_job_token: true

If none are set, they default to GitLab's public URLs.

!!! note Releasing to a private-hosted GitLab CE will only work for version v12.9+, due to dependencies on release functionality and direct asset linking.

Generic Package Registry

GitLab introduced the Generic Package Registry in Gitlab 13.5.

Normally, goreleaser uploads release files as "attachments", which may have administrative limits. Notably, hosted gitlab.com instances have a 10MB attachment limit, which cannot be changed.

Uploading to the Generic Package Registry does not have this restriction. To use it instead, set use_package_registry to true.

# .goreleaser.yml
gitlab_urls:
  use_package_registry: true

Example release

Here's an example of what the release might look like:

3.1 KiB Raw Blame History