mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-24 04:16:27 +02:00

History

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

docs

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

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

htmltest.yml

docs: fix htmltest

2022-10-12 00:04:19 -03:00

mkdocs.yml

docs: add woodpecker ci (#3516 )

2022-10-31 14:45:37 -03:00

README.md

feat: mTLS with client certificate (#3302 )

2022-08-12 09:44:54 -03:00

README.md

Documentation

Documentation is written in mkdocs and there are a few extensions that allow richer authoring than markdown.

To iterate with documentation, therefore, it is recommended to run the mkdocs server and view your pages in a browser.

Prerequisites

NOTE to M1/M2 mac owners

If running on an arm64-based mac (M1 or M2, aka "Applie Silicon"), you may find this method quite slow. Until multiarch docker images can be built and made available, you may wish to build your own via:

git clone git@github.com:squidfunk/mkdocs-material.git
docker build -t docker.io/squidfunk/mkdocs-material .