mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-10 03:47:03 +02:00
9f6a810fbc
This commit adds a `make_latest` boolean to the release configuration, to allow signaling to GitHub if the release should be marked as latest. Albeit being a boolean, the internal Go type is a string to allow to distinguish an empty string (default behavior: `true`) from an explicit `false`. For more information around the GitHub API field, see https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#create-a-release I did not include the `legacy` option, to not adopt something which appears to be scheduled for removal in the future. In addition, I opted for `make_latest` over `latest` because the option is only available for GitHub. Which keeps the latter key reserved for e.g. future use of a config option which is used across Git providers. Fixes #4159 Signed-off-by: Hidde Beydals <hidde@hhh.computer> |
||
|---|---|---|
| .. | ||
| docker | ||
| docs | ||
| htmltest.yml | ||
| mkdocs.yml | ||
| 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 .