Skip to content

Commit 5a9c8c8

Browse files
committed
docs: update
Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
1 parent 77ce7cc commit 5a9c8c8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+3864
-2354
lines changed

Taskfile.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ tasks:
2424
- ./pkg/config/
2525
cmds:
2626
- mkdir -p docs
27-
- cp -rf ../goreleaser/www/docs/customization ./docs/
28-
- cp -rf ../goreleaser/www/docs/deprecations.md ./docs/
27+
- cp -rf ../goreleaser/www/content/customization ./docs/
28+
- cp -rf ../goreleaser/www/content/resources/deprecations.md ./docs/
29+
- find ./docs/ -name '_index.md' -delete
2930
release:
3031
desc: Create a new tag
3132
vars:

docs/customization/announce/bluesky.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Bluesky
1+
---
2+
title: "Bluesky"
3+
weight: 10
4+
---
25

36
To use [Bluesky](https://bsky.app/), you need to create an account, and set the
47
following environment variable on your pipeline:
@@ -8,12 +11,12 @@ following environment variable on your pipeline:
811
After this, you can add following section to your `.goreleaser.yaml`
912
configuration:
1013

11-
```yaml title=".goreleaser.yaml"
14+
```yaml {filename=".goreleaser.yaml"}
1215
announce:
1316
bluesky:
1417
# Whether it's enabled or not.
1518
#
16-
# Templates: allowed (since v2.6).
19+
# Templates: allowed. {{< inline_version "v2.6" >}}
1720
enabled: true
1821

1922
# Message template to use while publishing.
@@ -27,4 +30,4 @@ announce:
2730
username: "my-project.bsky.social"
2831
```
2932
30-
<!-- md:templates -->
33+
{{< templates >}}

docs/customization/announce/discord.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Discord
1+
---
2+
title: "Discord"
3+
weight: 20
4+
---
25

36
To use [Discord](https://discord.com/), you need
47
to [create a Webhook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks), and set following
@@ -9,12 +12,12 @@ environment variables on your pipeline:
912

1013
After this, you can add following section to your `.goreleaser.yaml` config:
1114

12-
```yaml title=".goreleaser.yaml"
15+
```yaml {filename=".goreleaser.yaml"}
1316
announce:
1417
discord:
1518
# Whether its enabled or not.
1619
#
17-
# Templates: allowed (since v2.6).
20+
# Templates: allowed. {{< inline_version "v2.6" >}}
1821
enabled: true
1922

2023
# Message template to use while publishing.
@@ -39,4 +42,4 @@ announce:
3942
icon_url: ""
4043
```
4144
42-
<!-- md:templates -->
45+
{{< templates >}}

docs/customization/announce/discourse.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
# Discourse
1+
---
2+
title: "Discourse"
3+
weight: 30
4+
---
25

3-
<!-- md:version v2.13 -->
6+
{{< version "v2.13" >}}
47

58
This announcer enables posting new release messages to a
69
[Discourse](https://discourse.org/) forum.
@@ -25,7 +28,7 @@ with the API key as the value:
2528
After this, you can add following section to your `.goreleaser.yaml`
2629
configuration:
2730

28-
```yaml title=".goreleaser.yaml"
31+
```yaml {filename=".goreleaser.yaml"}
2932
announce:
3033
discourse:
3134
# Whether this announcer is enabled or not.
@@ -62,7 +65,7 @@ announce:
6265
category_id: 4
6366
```
6467
65-
<!-- md:templates -->
68+
{{< templates >}}
6669
6770
## Troubleshooting
6871

docs/customization/announce/index.md

Lines changed: 0 additions & 40 deletions
This file was deleted.
Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
1-
# LinkedIn
1+
---
2+
title: "LinkedIn"
3+
weight: 40
4+
---
25

36
For it to work, you'll need to set some environment variables on your pipeline:
47

58
- `LINKEDIN_ACCESS_TOKEN`
69

7-
!!! warning
8-
9-
We currently don't support posting in groups.
10+
> [!WARNING]
11+
> We currently don't support posting in groups.
1012
1113
Then, you can add something like the following to your `.goreleaser.yaml` config:
1214

13-
```yaml title=".goreleaser.yaml"
15+
```yaml {filename=".goreleaser.yaml"}
1416
announce:
1517
linkedin:
1618
# Whether its enabled or not.
1719
#
18-
# Templates: allowed (since v2.6).
20+
# Templates: allowed. {{< inline_version "v2.6" >}}
1921
enabled: true
2022

2123
# Message to use while publishing.
@@ -24,4 +26,4 @@ announce:
2426
message_template: "Awesome project {{.Tag}} is out!"
2527
```
2628
27-
<!-- md:templates -->
29+
{{< templates >}}

docs/customization/announce/mastodon.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Mastodon
1+
---
2+
title: "Mastodon"
3+
weight: 50
4+
---
25

36
For it to work, you'll need to create a new Mastodon app
47
`https://social.yourdomain.tld/settings/applications/new` with `write:statuses`
@@ -11,12 +14,12 @@ permissions, and set the following environment variables in your pipeline:
1114
Then, you can add something like the following to your `.goreleaser.yaml`
1215
configuration file:
1316

14-
```yaml title=".goreleaser.yaml"
17+
```yaml {filename=".goreleaser.yaml"}
1518
announce:
1619
mastodon:
1720
# Whether its enabled or not.
1821
#
19-
# Templates: allowed (since v2.6).
22+
# Templates: allowed. {{< inline_version "v2.6" >}}
2023
enabled: true
2124

2225
# Message to use while publishing.
@@ -29,4 +32,4 @@ announce:
2932
server: https://mastodon.social
3033
```
3134
32-
<!-- md:templates -->
35+
{{< templates >}}

docs/customization/announce/mattermost.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Mattermost
1+
---
2+
title: "Mattermost"
3+
weight: 60
4+
---
25

36
For it to work, you'll need to [create a new Incoming Webhook](https://docs.mattermost.com/developer/webhooks-incoming.html) in your own Mattermost deployment, and set some
47
environment variables on your pipeline:
@@ -7,12 +10,12 @@ environment variables on your pipeline:
710

811
Then, you can add something like the following to your `.goreleaser.yaml` config:
912

10-
```yaml title=".goreleaser.yaml"
13+
```yaml {filename=".goreleaser.yaml"}
1114
announce:
1215
mattermost:
1316
# Whether its enabled or not.
1417
#
15-
# Templates: allowed (since v2.6).
18+
# Templates: allowed. {{< inline_version "v2.6" >}}
1619
enabled: true
1720

1821
# Title to use while publishing.
@@ -44,4 +47,4 @@ announce:
4447
icon_url: ""
4548
```
4649
47-
<!-- md:templates -->
50+
{{< templates >}}

docs/customization/announce/opencollective.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
1-
# OpenCollective
1+
---
2+
title: "OpenCollective"
3+
weight: 70
4+
---
25

36
For it to work, you'll need to create a personal token (`https://opencollective.com/<user>/admin/for-developers`) and set the environment variable on your pipeline:
47

58
- `OPENCOLLECTIVE_TOKEN`
69

710
Then, you can add something like the following to your `.goreleaser.yaml` config:
811

9-
```yaml title=".goreleaser.yaml"
12+
```yaml {filename=".goreleaser.yaml"}
1013
announce:
1114
opencollective:
1215
# Whether its enabled or not.
1316
#
14-
# Templates: allowed (since v2.6).
17+
# Templates: allowed. {{< inline_version "v2.6" >}}
1518
enabled: true
1619

1720
# Collective slug
@@ -31,4 +34,4 @@ announce:
3134
message_template: "Awesome project {{.Tag}} is out!"
3235
```
3336
34-
<!-- md:templates -->
37+
{{< templates >}}

docs/customization/announce/reddit.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Reddit
1+
---
2+
title: "Reddit"
3+
weight: 80
4+
---
25

36
For it to work, you'll need to [create a new Reddit app](https://www.reddit.com/prefs/apps), and set some environment
47
variables on your pipeline:
@@ -8,12 +11,12 @@ variables on your pipeline:
811

912
Then, you can add something like the following to your `.goreleaser.yaml` config:
1013

11-
```yaml title=".goreleaser.yaml"
14+
```yaml {filename=".goreleaser.yaml"}
1215
announce:
1316
reddit:
1417
# Whether its enabled or not.
1518
#
16-
# Templates: allowed (since v2.6).
19+
# Templates: allowed. {{< inline_version "v2.6" >}}
1720
enabled: true
1821

1922
# Application ID for Reddit Application
@@ -35,4 +38,4 @@ announce:
3538
title_template: ''GoReleaser {{ .Tag }} was just released!''
3639
```
3740
38-
<!-- md:templates -->
41+
{{< templates >}}

0 commit comments

Comments
 (0)