mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-22 04:08:49 +02:00

History

Jeffrey Cafferata 75c23abdca

docs: GitHub Actions code example (#4516 )

I've changed the GitHub Action workflow code example to be more inline
with the code example on the GitHub repository:

1. https://goreleaser.com/ci/actions/#workflow
2.
https://github.com/goreleaser/goreleaser-action?tab=readme-ov-file#workflow

This is done by four commits for better code/git diff:

1.
7f6d9eefff
Changed the GitHub action workflow from `actions/checkout@v3` to
`actions/checkout@v4`.

Copying from the code example on the GitHub repository
`goreleaser/goreleaser-action`:

1.
effc880f3d
The `name` items
2.
9d7fc2949e
The comments
3.
3118f60fb0
The workflow trigger `on`: `pull_request`

2024-01-04 09:21:15 -03:00

docs

docs: GitHub Actions code example (#4516 )

2024-01-04 09:21:15 -03:00

htmltest.yml

docs: blog (#4264 )

2023-09-14 13:53:40 -03:00

mkdocs.yml

docs: fix discord link

2023-11-04 02:42:53 +00: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 .