go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-07-05 00:59:04 +02:00
Code Issues Releases Activity

docs: include markdown plugin (#4098)

Browse Source 
I was really tired of copying and pasting that over and over again and
keeping it all in sync...

Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
This commit is contained in:
Carlos Alexandro Becker
2023-06-13 23:25:18 -03:00
committed by GitHub
parent f33968f187
commit 56dfb8b5b0
9 changed files with 345 additions and 558 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
Taskfile.yml
View File

@ -1,6 +1,6 @@
# https://taskfile.dev # https://taskfile.dev
version: '3' version: "3"
env: env:
GO111MODULE: on GO111MODULE: on
@ -117,13 +117,14 @@ tasks:
desc: Start documentation server desc: Start documentation server
cmds: cmds:
- task: docs:generate - task: docs:generate
- '{{.DOCKER}} run --rm -p 8000:8000 -v ${PWD}/www:/docs docker.io/squidfunk/mkdocs-material' - "{{.DOCKER}} build -t mkdocs -f www/docker/Dockerfile www/docker"
- "{{.DOCKER}} run --rm -p 8000:8000 -v ${PWD}/www:/docs mkdocs"
docs:build: docs:build:
desc: Build docs desc: Build docs
cmds: cmds:
- task: docs:generate - task: docs:generate
- '{{.DOCKER}} run --rm -v ${PWD}/www:/docs docker.io/squidfunk/mkdocs-material build' - "{{.DOCKER}} run --rm -v ${PWD}/www:/docs docker.io/squidfunk/mkdocs-material build"
release: release:
desc: Create a new tag desc: Create a new tag
@ -143,70 +144,70 @@ tasks:
goreleaser:test:rpm: goreleaser:test:rpm:
desc: Tests rpm packages desc: Tests rpm packages
vars: vars:
rpm: 'rpm --nodeps -ivh' rpm: "rpm --nodeps -ivh"
cmds: cmds:
- task: goreleaser:test:pkg - task: goreleaser:test:pkg
vars: vars:
Platform: '386' Platform: "386"
Image: centos:centos7 Image: centos:centos7
Cmd: '{{.rpm}} goreleaser-*.i386.rpm' Cmd: "{{.rpm}} goreleaser-*.i386.rpm"
- task: goreleaser:test:pkg - task: goreleaser:test:pkg
vars: vars:
Platform: 'amd64' Platform: "amd64"
Image: fedora Image: fedora
Cmd: '{{.rpm}} goreleaser-*.x86_64.rpm' Cmd: "{{.rpm}} goreleaser-*.x86_64.rpm"
- task: goreleaser:test:pkg - task: goreleaser:test:pkg
vars: vars:
Platform: 'arm64' Platform: "arm64"
Image: fedora Image: fedora
Cmd: '{{.rpm}} goreleaser-*.aarch64.rpm' Cmd: "{{.rpm}} goreleaser-*.aarch64.rpm"
goreleaser:test:deb: goreleaser:test:deb:
desc: Tests deb packages desc: Tests deb packages
vars: vars:
dpkg: 'dpkg --ignore-depends=git -i' dpkg: "dpkg --ignore-depends=git -i"
cmds: cmds:
- task: goreleaser:test:pkg - task: goreleaser:test:pkg
vars: vars:
Platform: 'amd64' Platform: "amd64"
Image: ubuntu Image: ubuntu
Cmd: '{{.dpkg}} goreleaser*_amd64.deb' Cmd: "{{.dpkg}} goreleaser*_amd64.deb"
- task: goreleaser:test:pkg - task: goreleaser:test:pkg
vars: vars:
Platform: 'arm64' Platform: "arm64"
Image: ubuntu Image: ubuntu
Cmd: '{{.dpkg}} goreleaser*_arm64.deb' Cmd: "{{.dpkg}} goreleaser*_arm64.deb"
- task: goreleaser:test:pkg - task: goreleaser:test:pkg
vars: vars:
Platform: 'arm/7' Platform: "arm/7"
Image: ubuntu Image: ubuntu
Cmd: '{{.dpkg}} goreleaser*_armhf.deb' Cmd: "{{.dpkg}} goreleaser*_armhf.deb"
goreleaser:test:apk: goreleaser:test:apk:
desc: Tests apk packages desc: Tests apk packages
vars: vars:
apk: 'apk add --allow-untrusted -U' apk: "apk add --allow-untrusted -U"
cmds: cmds:
- task: goreleaser:test:pkg - task: goreleaser:test:pkg
vars: vars:
Platform: '386' Platform: "386"
Image: alpine Image: alpine
Cmd: '{{.apk}} goreleaser*_x86.apk' Cmd: "{{.apk}} goreleaser*_x86.apk"
- task: goreleaser:test:pkg - task: goreleaser:test:pkg
vars: vars:
Platform: 'amd64' Platform: "amd64"
Image: alpine Image: alpine
Cmd: '{{.apk}} goreleaser*_x86_64.apk' Cmd: "{{.apk}} goreleaser*_x86_64.apk"
- task: goreleaser:test:pkg - task: goreleaser:test:pkg
vars: vars:
Platform: 'arm64' Platform: "arm64"
Image: alpine Image: alpine
Cmd: '{{.apk}} goreleaser*_aarch64.apk' Cmd: "{{.apk}} goreleaser*_aarch64.apk"
- task: goreleaser:test:pkg - task: goreleaser:test:pkg
vars: vars:
Platform: 'arm/7' Platform: "arm/7"
Image: alpine Image: alpine
Cmd: '{{.apk}} goreleaser*_armv7.apk' Cmd: "{{.apk}} goreleaser*_armv7.apk"
goreleaser:test: goreleaser:test:
desc: Test built linux packages desc: Test built linux packages

2
scripts/pages/build.sh
View File

@ -3,7 +3,7 @@ set -euo pipefail
# install # install
pip install --upgrade pip pip install --upgrade pip
pip install -U mkdocs-material mkdocs-redirects mkdocs-minify-plugin lunr pip install -U mkdocs-material mkdocs-redirects mkdocs-minify-plugin mkdocs-include-markdown-plugin lunr
# prepare # prepare
version="$(cat ./www/docs/static/latest)" version="$(cat ./www/docs/static/latest)"

2
www/docker/Dockerfile Normal file
View File

@ -0,0 +1,2 @@
FROM squidfunk/mkdocs-material
RUN pip install mkdocs-include-markdown-plugin

87
www/docs/customization/homebrew.md
View File

@ -44,85 +44,6 @@ brews:
# We will probably unify this in the next major version like it is # We will probably unify this in the next major version like it is
# done with scoop. # done with scoop.
# GitHub/GitLab repository to push the formula to
tap:
# Repository owner.
#
# Templates: allowed
owner: user
# Repository name.
#
# Templates: allowed
name: homebrew-tap
# Optionally a branch can be provided.
#
# Default: default repository branch.
# Templates: allowed
branch: main
# Optionally a token can be provided, if it differs from the token
# provided to GoReleaser
#
# Templates: allowed
token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}"
# Sets up pull request creation instead of just pushing to the given branch.
# Make sure the 'branch' property is different from base before enabling
# it.
#
# Since: v1.17
pull_request:
# Whether to enable it or not.
enabled: true
# Whether to open the PR as a draft or not.
#
# Default: false
# Since: v1.19
draft: true
# Base can also be another repository, in which case the owner and name
# above will be used as HEAD, allowing cross-repository pull requests.
#
# Since: v1.19
base:
owner: org
name: nur
branch: main
# Clone, create the file, commit and push, to a regular Git repository.
#
# Notice that this will only have any effect if the given URL is not
# empty.
#
# Since: v1.18
git:
# The Git URL to push.
#
# Templates: allowed
url: 'ssh://git@myserver.com:repo.git'
# The SSH private key that should be used to commit to the Git
# repository.
# This can either be a path or the key contents.
#
# IMPORTANT: the key must not be password-protected.
#
# WARNING: do not expose your private key in the configuration file!
#
# Templates: allowed
private_key: '{{ .Env.PRIVATE_KEY_PATH }}'
# The value to be passed to `GIT_SSH_COMMAND`.
# This is mainly used to specify the SSH private key used to pull/push
# to the Git URL.
#
# Default: 'ssh -i {{ .KeyPath }} -o StrictHostKeyChecking=accept-new -F /dev/null'
# Templates: allowed
ssh_command: 'ssh -i {{ .Env.KEY }} -o SomeOption=yes'
# URL which is determined by the given Token (github, gitlab or gitea). # URL which is determined by the given Token (github, gitlab or gitea).
# #
# Default depends on the client. # Default depends on the client.
@ -227,10 +148,15 @@ brews:
# Could be used to do any additional work after the "install" script # Could be used to do any additional work after the "install" script
post_install: | post_install: |
etc.install "app-config.conf" etc.install "app-config.conf"
... # ...
# GitHub/GitLab repository to push the formula to
tap:
{% include-markdown "../includes/repository.md" comments=false %}
``` ```
!!! tip !!! tip
Learn more about the [name template engine](/customization/templates/). Learn more about the [name template engine](/customization/templates/).
By defining the `brew` section, GoReleaser will take care of publishing the By defining the `brew` section, GoReleaser will take care of publishing the
@ -278,6 +204,7 @@ end
``` ```
!!! info !!! info
Note that GoReleaser does not generate a valid homebrew-core formula. Note that GoReleaser does not generate a valid homebrew-core formula.
The generated formulas are meant to be published as The generated formulas are meant to be published as
[homebrew taps](https://docs.brew.sh/Taps.html), and in their current [homebrew taps](https://docs.brew.sh/Taps.html), and in their current

84
www/docs/customization/krew.md
View File

@ -39,85 +39,6 @@ krews:
# gitlab) owner and name are from the same kind. We will probably unify this # gitlab) owner and name are from the same kind. We will probably unify this
# in the next major version like it is done with scoop. # in the next major version like it is done with scoop.
# GitHub/GitLab repository to push the Krew plugin to
# Gitea is not supported yet, but the support coming
index:
# Repository owner.
#
# Templates: allowed
owner: user
# Repository name.
#
# Templates: allowed
name: krew-plugins
# Optionally a branch can be provided.
#
# Default: default repository branch
# Templates: allowed
branch: main
# Optionally a token can be provided, if it differs from the token
# provided to GoReleaser
# Templates: allowed
token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}"
# Sets up pull request creation instead of just pushing to the given branch.
# Make sure the 'branch' property is different from base before enabling
# it.
#
# Since: v1.17
pull_request:
# Whether to enable it or not.
enabled: true
# Whether to open the PR as a draft or not.
#
# Default: false
# Since: v1.19
draft: true
# Base can also be another repository, in which case the owner and name
# above will be used as HEAD, allowing cross-repository pull requests.
#
# Since: v1.19
base:
owner: org
name: nur
branch: main
# Clone, create the file, commit and push, to a regular Git repository.
#
# Notice that this will only have any effect if the given URL is not
# empty.
#
# Since: v1.18
git:
# The Git URL to push.
#
# Templates: allowed
url: 'ssh://git@myserver.com:repo.git'
# The SSH private key that should be used to commit to the Git
# repository.
# This can either be a path or the key contents.
#
# IMPORTANT: the key must not be password-protected.
#
# WARNING: do not expose your private key in the configuration file!
#
# Templates: allowed
private_key: '{{ .Env.PRIVATE_KEY_PATH }}'
# The value to be passed to `GIT_SSH_COMMAND`.
# This is mainly used to specify the SSH private key used to pull/push
# to the Git URL.
#
# Default: 'ssh -i {{ .KeyPath }} -o StrictHostKeyChecking=accept-new -F /dev/null'
# Templates: allowed
ssh_command: 'ssh -i {{ .Env.KEY }} -o SomeOption=yes'
# URL which is determined by the given Token (github or # URL which is determined by the given Token (github or
# gitlab) # gitlab)
# Default: # Default:
@ -160,9 +81,14 @@ krews:
# If set to auto, the release will not be uploaded to the Krew plugin # If set to auto, the release will not be uploaded to the Krew plugin
# in case there is an indicator for prerelease in the tag e.g. v1.0.0-rc1 # in case there is an indicator for prerelease in the tag e.g. v1.0.0-rc1
skip_upload: true skip_upload: true
# GitHub/GitLab repository to push the Krew plugin to.
index:
{% include-markdown "../includes/repository.md" comments=false %}
``` ```
!!! tip !!! tip
Learn more about the [name template engine](/customization/templates/). Learn more about the [name template engine](/customization/templates/).
## Limitations ## Limitations

86
www/docs/customization/nix.md
View File

@ -10,7 +10,7 @@ The `nix` section specifies how the pkgs should be created:
```yaml ```yaml
# .goreleaser.yaml # .goreleaser.yaml
nix: nix:
- - #
# Name of the recipe # Name of the recipe
# #
# Default: ProjectName # Default: ProjectName
@ -20,8 +20,8 @@ nix:
# IDs of the archives to use. # IDs of the archives to use.
# Empty means all IDs. # Empty means all IDs.
ids: ids:
- foo - foo
- bar - bar
# GOAMD64 to specify which amd64 version to use if there are multiple # GOAMD64 to specify which amd64 version to use if there are multiple
# versions from the build section. # versions from the build section.
@ -29,81 +29,6 @@ nix:
# Default: v1 # Default: v1
goamd64: v1 goamd64: v1
# GitHub/GitLab repository to push the pkg to.
repository:
# Repository owner.
#
# Templates: allowed
owner: user
# Repository name.
#
# Templates: allowed
name: nur
# Optionally a branch can be provided.
#
# Default: default repository branch.
# Templates: allowed
branch: foo
# Optionally a token can be provided, if it differs from the token
# provided to GoReleaser
#
# Templates: allowed
token: "{{ .Env.NUR_GITHUB_TOKEN }}"
# Sets up pull request creation instead of just pushing to the given branch.
# Make sure the 'branch' property is different from base before enabling
# it.
pull_request:
# Whether to enable it or not.
enabled: true
# Whether to open the PR as a draft or not.
#
# Default: false
# Since: v1.19
draft: true
# Base can also be another repository, in which case the owner and name
# above will be used as HEAD, allowing cross-repository pull requests.
#
# Since: v1.19
base:
owner: org
name: nur
branch: main
# Clone, create the file, commit and push, to a regular Git repository.
#
# Notice that this will only have any effect if the given URL is not
# empty.
git:
# The Git URL to push.
#
# Templates: allowed
url: 'ssh://git@myserver.com:repo.git'
# The SSH private key that should be used to commit to the Git
# repository.
# This can either be a path or the key contents.
#
# IMPORTANT: the key must not be password-protected.
#
# WARNING: do not expose your private key in the configuration file!
#
# Templates: allowed
private_key: '{{ .Env.PRIVATE_KEY_PATH }}'
# The value to be passed to `GIT_SSH_COMMAND`.
# This is mainly used to specify the SSH private key used to pull/push
# to the Git URL.
#
# Default: 'ssh -i {{ .KeyPath }} -o StrictHostKeyChecking=accept-new -F /dev/null'
# Templates: allowed
ssh_command: 'ssh -i {{ .Env.KEY }} -o SomeOption=yes'
# URL which is determined by the given Token (github, gitlab or gitea). # URL which is determined by the given Token (github, gitlab or gitea).
# #
# Default depends on the client. # Default depends on the client.
@ -161,9 +86,14 @@ nix:
# Templates: allowed # Templates: allowed
post_install: | post_install: |
installShellCompletion ./completions/* installShellCompletion ./completions/*
# GitHub/GitLab repository to push the pkg to.
repository:
{% include-markdown "../includes/repository.md" comments=false %}
``` ```
!!! tip !!! tip
Learn more about the [name template engine](/customization/templates/). Learn more about the [name template engine](/customization/templates/).
## Things not yet implemented ## Things not yet implemented

225
www/docs/customization/scoop.md
View File

@ -10,170 +10,97 @@ commented example below:
# .goreleaser.yaml # .goreleaser.yaml
# Since: v1.18 # Since: v1.18
scoops: scoops:
- - # Name of the recipe
# Name of the recipe #
# # Default: ProjectName
# Default: ProjectName # Templates: allowed (since v1.19)
# Templates: allowed (since v1.19) name: myproject
name: myproject
# URL which is determined by the given Token (github or gitlab) # URL which is determined by the given Token (github or gitlab)
# #
# Default: # Default:
# GitHub: 'https://github.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}' # GitHub: 'https://github.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}'
# GitLab: 'https://gitlab.com/<repo_owner>/<repo_name>/-/releases/{{ .Tag }}/downloads/{{ .ArtifactName }}' # GitLab: 'https://gitlab.com/<repo_owner>/<repo_name>/-/releases/{{ .Tag }}/downloads/{{ .ArtifactName }}'
# Gitea: 'https://gitea.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}' # Gitea: 'https://gitea.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .ArtifactName }}'
# Templates: allowed # Templates: allowed
url_template: "http://github.mycompany.com/foo/bar/releases/{{ .Tag }}/{{ .ArtifactName }}" url_template: "http://github.mycompany.com/foo/bar/releases/{{ .Tag }}/{{ .ArtifactName }}"
# Repository to push the app manifest to. # Folder inside the repository to put the scoop.
bucket: #
# Repository owner. # Note that while scoop works if the manifests are in a folder,
# 'scoop bucket list' will show 0 manifests if they are not in the root
# folder.
# In short, it's generally better to leave this empty.
folder: Scoops
# Git author used to commit to the repository.
commit_author:
name: goreleaserbot
email: bot@goreleaser.com
# The project name and current git tag are used in the format string.
# #
# Templates: allowed # Templates: allowed
owner: user commit_msg_template: "Scoop update for {{ .ProjectName }} version {{ .Tag }}"
# Repository name. # Your app's homepage.
# #
# Templates: allowed # Templates: allowed (since v1.19)
name: scoop-bucket homepage: "https://example.com/"
# Optionally a branch can be provided. # Your app's description.
# #
# Default: the repository default branch # Templates: allowed (since v1.19)
# Templates: allowed description: "Software to create fast and easy drum rolls."
branch: main
# Optionally a token can be provided, if it differs from the token provided # Your app's license
# to GoReleaser license: MIT
# Setting this will prevent goreleaser to actually try to commit the updated
# manifest leaving the responsibility of publishing it to the user.
# If set to auto, the release will not be uploaded to the scoop bucket
# in case there is an indicator for prerelease in the tag e.g. v1.0.0-rc1
# #
# Templates: allowed # Templates: allowed (since v1.19)
token: "{{ .Env.SCOOP_TAP_GITHUB_TOKEN }}" skip_upload: true
# Sets up pull request creation instead of just pushing to the given branch. # Persist data between application updates
# Make sure the 'branch' property is different from base before enabling persist:
# it. - "data"
- "config.toml"
# An array of commands to be executed before an application is installed.
pre_install: ["Write-Host 'Running preinstall command'"]
# An array of commands to be executed after an application is installed.
post_install: ["Write-Host 'Running postinstall command'"]
# An array of dependencies.
# #
# Since: v1.17 # Since GoReleaser v1.16
pull_request: depends: ["git", "foo"]
# Whether to enable it or not.
enabled: true
# Whether to open the PR as a draft or not. # A two-dimensional array of string, specifies the shortcut values to make available in the startmenu.
# # The array has to contain an executable/label pair. The third and fourth element are optional.
# Default: false
# Since: v1.19
draft: true
# Base can also be another repository, in which case the owner and name
# above will be used as HEAD, allowing cross-repository pull requests.
#
# Since: v1.19
base:
owner: org
name: nur
branch: main
# Clone, create the file, commit and push, to a regular Git repository.
# #
# Notice that this will only have any effect if the given URL is not # Since GoReleaser v1.17.0.
# empty. shortcuts: [["drumroll.exe", "drumroll"]]
# GOAMD64 to specify which amd64 version to use if there are multiple versions
# from the build section.
# #
# Since: v1.18 # Default: 'v1'
git: goamd64: v3
# The Git URL to push.
#
# Templates: allowed
url: 'ssh://git@myserver.com:repo.git'
# The SSH private key that should be used to commit to the Git # Repository to push the app manifest to.
# repository. bucket:
# This can either be a path or the key contents. {% include-markdown "../includes/repository.md" comments=false %}
#
# IMPORTANT: the key must not be password-protected.
#
# WARNING: do not expose your private key in the configuration file!
#
# Templates: allowed
private_key: '{{ .Env.PRIVATE_KEY_PATH }}'
# The value to be passed to `GIT_SSH_COMMAND`.
# This is mainly used to specify the SSH private key used to pull/push
# to the Git URL.
#
# Default: 'ssh -i {{ .KeyPath }} -o StrictHostKeyChecking=accept-new -F /dev/null'
# Templates: allowed
ssh_command: 'ssh -i {{ .Env.KEY }} -o SomeOption=yes'
# Folder inside the repository to put the scoop.
#
# Note that while scoop works if the manifests are in a folder,
# 'scoop bucket list' will show 0 manifests if they are not in the root
# folder.
# In short, it's generally better to leave this empty.
folder: Scoops
# Git author used to commit to the repository.
commit_author:
name: goreleaserbot
email: bot@goreleaser.com
# The project name and current git tag are used in the format string.
#
# Templates: allowed
commit_msg_template: "Scoop update for {{ .ProjectName }} version {{ .Tag }}"
# Your app's homepage.
#
# Templates: allowed (since v1.19)
homepage: "https://example.com/"
# Your app's description.
#
# Templates: allowed (since v1.19)
description: "Software to create fast and easy drum rolls."
# Your app's license
license: MIT
# Setting this will prevent goreleaser to actually try to commit the updated
# manifest leaving the responsibility of publishing it to the user.
# If set to auto, the release will not be uploaded to the scoop bucket
# in case there is an indicator for prerelease in the tag e.g. v1.0.0-rc1
#
# Templates: allowed (since v1.19)
skip_upload: true
# Persist data between application updates
persist:
- "data"
- "config.toml"
# An array of commands to be executed before an application is installed.
pre_install: ["Write-Host 'Running preinstall command'"]
# An array of commands to be executed after an application is installed.
post_install: ["Write-Host 'Running postinstall command'"]
# An array of dependencies.
#
# Since GoReleaser v1.16
depends: ["git", "foo"]
# A two-dimensional array of string, specifies the shortcut values to make available in the startmenu.
# The array has to contain an executable/label pair. The third and fourth element are optional.
#
# Since GoReleaser v1.17.0.
shortcuts: [["drumroll.exe", "drumroll"]]
# GOAMD64 to specify which amd64 version to use if there are multiple versions
# from the build section.
#
# Default: 'v1'
goamd64: v3
``` ```
!!! tip
Learn more about the [name template engine](/customization/templates/).
By defining the `scoop` section, GoReleaser will take care of publishing the By defining the `scoop` section, GoReleaser will take care of publishing the
Scoop app. Assuming that the project name is `drumroll`, and the current tag is Scoop app. Assuming that the project name is `drumroll`, and the current tag is
`v1.2.3`, the above configuration will generate a `drumroll.json` manifest in `v1.2.3`, the above configuration will generate a `drumroll.json` manifest in
@ -184,14 +111,12 @@ the root of the repository specified in the `bucket` section.
"version": "1.2.3", "version": "1.2.3",
"architecture": { "architecture": {
"64bit": { "64bit": {
"url": "url": "https://github.com/user/drumroll/releases/download/1.2.3/drumroll_1.2.3_windows_amd64.tar.gz",
"https://github.com/user/drumroll/releases/download/1.2.3/drumroll_1.2.3_windows_amd64.tar.gz",
"bin": "drumroll.exe", "bin": "drumroll.exe",
"hash": "86920b1f04173ee08773136df31305c0dae2c9927248ac259e02aafd92b6008a" "hash": "86920b1f04173ee08773136df31305c0dae2c9927248ac259e02aafd92b6008a"
}, },
"32bit": { "32bit": {
"url": "url": "https://github.com/user/drumroll/releases/download/1.2.3/drumroll_1.2.3_windows_386.tar.gz",
"https://github.com/user/drumroll/releases/download/1.2.3/drumroll_1.2.3_windows_386.tar.gz",
"bin": "drumroll.exe", "bin": "drumroll.exe",
"hash": "283faa524ef41987e51c8786c61bb56658a489f63512b32139d222b3ee1d18e6" "hash": "283faa524ef41987e51c8786c61bb56658a489f63512b32139d222b3ee1d18e6"
} }

75
www/docs/includes/repository.md Normal file
View File

@ -0,0 +1,75 @@
# Repository owner.
#
# Templates: allowed
owner: caarlos0
# Repository name.
#
# Templates: allowed
name: my-repo
# Optionally a branch can be provided.
#
# Default: default repository branch
# Templates: allowed
branch: main
# Optionally a token can be provided, if it differs from the token
# provided to GoReleaser
# Templates: allowed
token: "{{ .Env.GITHUB_PERSONAL_AUTH_TOKEN }}"
# Sets up pull request creation instead of just pushing to the given branch.
# Make sure the 'branch' property is different from base before enabling
# it.
#
# Since: v1.17
pull_request:
# Whether to enable it or not.
enabled: true
# Whether to open the PR as a draft or not.
#
# Default: false
# Since: v1.19
draft: true
# Base can also be another repository, in which case the owner and name
# above will be used as HEAD, allowing cross-repository pull requests.
#
# Since: v1.19
base:
owner: goreleaser
name: my-repo
branch: main
# Clone, create the file, commit and push, to a regular Git repository.
#
# Notice that this will only have any effect if the given URL is not
# empty.
#
# Since: v1.18
git:
# The Git URL to push.
#
# Templates: allowed
url: 'ssh://git@myserver.com:repo.git'
# The SSH private key that should be used to commit to the Git
# repository.
# This can either be a path or the key contents.
#
# IMPORTANT: the key must not be password-protected.
#
# WARNING: do not expose your private key in the configuration file!
#
# Templates: allowed
private_key: '{{ .Env.PRIVATE_KEY_PATH }}'
# The value to be passed to `GIT_SSH_COMMAND`.
# This is mainly used to specify the SSH private key used to pull/push
# to the Git URL.
#
# Default: 'ssh -i {{ .KeyPath }} -o StrictHostKeyChecking=accept-new -F /dev/null'
# Templates: allowed
ssh_command: 'ssh -i {{ .Env.KEY }} -o SomeOption=yes'

289
www/mkdocs.yml
View File

@ -15,12 +15,12 @@ theme:
include_search_page: false include_search_page: false
search_index_only: true search_index_only: true
palette: palette:
- media: "(prefers-color-scheme: light)" # Light mode - media: "(prefers-color-scheme: light)" # Light mode
scheme: default scheme: default
toggle: toggle:
icon: material/lightbulb-outline icon: material/lightbulb-outline
name: Switch to light mode name: Switch to light mode
- media: "(prefers-color-scheme: dark)" # Dark mode - media: "(prefers-color-scheme: dark)" # Dark mode
scheme: slate scheme: slate
primary: light blue primary: light blue
accent: indigo accent: indigo
@ -50,9 +50,10 @@ plugins:
l.md: https://www.linkedin.com/company/goreleaser/ l.md: https://www.linkedin.com/company/goreleaser/
m.md: https://fosstodon.org/@goreleaser m.md: https://fosstodon.org/@goreleaser
t.md: https://twitter.com/goreleaser t.md: https://twitter.com/goreleaser
'customization/build.md': customization/builds.md "customization/build.md": customization/builds.md
- minify: - minify:
minify_html: true minify_html: true
- include-markdown
extra: extra:
social: social:
@ -64,147 +65,147 @@ extra:
link: https://fosstodon.org/@goreleaser link: https://fosstodon.org/@goreleaser
nav: nav:
- Home: index.md - Home: index.md
- intro.md - intro.md
- install.md - install.md
- quick-start.md - quick-start.md
- how-it-works.md - how-it-works.md
- Limitations: - Limitations:
- limitations/cgo.md - limitations/cgo.md
- limitations/semver.md - limitations/semver.md
- SCM: - SCM:
- scm/github.md - scm/github.md
- scm/gitlab.md - scm/gitlab.md
- scm/gitea.md - scm/gitea.md
- Continuous Integration: - Continuous Integration:
- About: ci/index.md - About: ci/index.md
- ci/actions.md - ci/actions.md
- ci/azurepipelines.md - ci/azurepipelines.md
- ci/circle.md - ci/circle.md
- ci/cirrus.md - ci/cirrus.md
- ci/cloudbuild.md - ci/cloudbuild.md
- ci/codefresh.md - ci/codefresh.md
- ci/drone.md - ci/drone.md
- ci/gitlab.md - ci/gitlab.md
- ci/jenkins.md - ci/jenkins.md
- ci/semaphore.md - ci/semaphore.md
- ci/travis.md - ci/travis.md
- ci/woodpecker.md - ci/woodpecker.md
- Customization: - Customization:
- About: customization/index.md - About: customization/index.md
- Basics: - Basics:
- customization/includes.md - customization/includes.md
- customization/templates.md - customization/templates.md
- customization/templatefiles.md - customization/templatefiles.md
- customization/env.md - customization/env.md
- customization/hooks.md - customization/hooks.md
- customization/dist.md - customization/dist.md
- customization/project.md - customization/project.md
- customization/git.md - customization/git.md
- Build: - Build:
- customization/builds.md - customization/builds.md
- customization/verifiable_builds.md - customization/verifiable_builds.md
- customization/monorepo.md - customization/monorepo.md
- customization/universalbinaries.md - customization/universalbinaries.md
- customization/upx.md - customization/upx.md
- customization/partial.md - customization/partial.md
- Packaging and Archiving: - Packaging and Archiving:
- customization/archive.md - customization/archive.md
- customization/nfpm.md - customization/nfpm.md
- customization/checksum.md - customization/checksum.md
- customization/snapcraft.md - customization/snapcraft.md
- customization/chocolatey.md - customization/chocolatey.md
- customization/docker.md - customization/docker.md
- customization/docker_manifest.md - customization/docker_manifest.md
- customization/ko.md - customization/ko.md
- customization/sbom.md - customization/sbom.md
- customization/reportsizes.md - customization/reportsizes.md
- Signing: - Signing:
- Checksums and artifacts: customization/sign.md - Checksums and artifacts: customization/sign.md
- Docker Images and Manifests: customization/docker_sign.md - Docker Images and Manifests: customization/docker_sign.md
- Publish: - Publish:
- customization/release.md - customization/release.md
- customization/snapshots.md - customization/snapshots.md
- customization/nightlies.md - customization/nightlies.md
- customization/blob.md - customization/blob.md
- customization/fury.md - customization/fury.md
- customization/homebrew.md - customization/homebrew.md
- customization/nix.md - customization/nix.md
- customization/aur.md - customization/aur.md
- customization/krew.md - customization/krew.md
- customization/scoop.md - customization/scoop.md
- customization/changelog.md - customization/changelog.md
- customization/upload.md - customization/upload.md
- customization/source.md - customization/source.md
- customization/publishers.md - customization/publishers.md
- customization/artifactory.md - customization/artifactory.md
- customization/milestone.md - customization/milestone.md
- Announce: - Announce:
- About: customization/announce/index.md - About: customization/announce/index.md
- customization/announce/discord.md - customization/announce/discord.md
- customization/announce/linkedin.md - customization/announce/linkedin.md
- customization/announce/mastodon.md - customization/announce/mastodon.md
- customization/announce/mattermost.md - customization/announce/mattermost.md
- customization/announce/opencollective.md - customization/announce/opencollective.md
- customization/announce/reddit.md - customization/announce/reddit.md
- customization/announce/slack.md - customization/announce/slack.md
- customization/announce/smtp.md - customization/announce/smtp.md
- customization/announce/teams.md - customization/announce/teams.md
- customization/announce/telegram.md - customization/announce/telegram.md
- customization/announce/twitter.md - customization/announce/twitter.md
- customization/announce/webhook.md - customization/announce/webhook.md
- Command Line Usage: - Command Line Usage:
- cmd/goreleaser.md - cmd/goreleaser.md
- cmd/goreleaser_init.md - cmd/goreleaser_init.md
- cmd/goreleaser_healthcheck.md - cmd/goreleaser_healthcheck.md
- cmd/goreleaser_check.md - cmd/goreleaser_check.md
- cmd/goreleaser_changelog.md - cmd/goreleaser_changelog.md
- cmd/goreleaser_build.md - cmd/goreleaser_build.md
- cmd/goreleaser_release.md - cmd/goreleaser_release.md
- cmd/goreleaser_continue.md - cmd/goreleaser_continue.md
- cmd/goreleaser_publish.md - cmd/goreleaser_publish.md
- cmd/goreleaser_announce.md - cmd/goreleaser_announce.md
- cmd/goreleaser_completion.md - cmd/goreleaser_completion.md
- cmd/goreleaser_completion_bash.md - cmd/goreleaser_completion_bash.md
- cmd/goreleaser_completion_fish.md - cmd/goreleaser_completion_fish.md
- cmd/goreleaser_completion_powershell.md - cmd/goreleaser_completion_powershell.md
- cmd/goreleaser_completion_zsh.md - cmd/goreleaser_completion_zsh.md
- cmd/goreleaser_jsonschema.md - cmd/goreleaser_jsonschema.md
- Common errors: - Common errors:
- errors/dirty.md - errors/dirty.md
- errors/multiple-tokens.md - errors/multiple-tokens.md
- errors/release-upload.md - errors/release-upload.md
- errors/docker-build.md - errors/docker-build.md
- errors/no-main.md - errors/no-main.md
- errors/build.md - errors/build.md
- errors/resource-not-accessible-by-integration.md - errors/resource-not-accessible-by-integration.md
- errors/no-history.md - errors/no-history.md
- errors/multiple-binaries-archive.md - errors/multiple-binaries-archive.md
- errors/scoop-archive.md - errors/scoop-archive.md
- deprecations.md - deprecations.md
- Cookbooks: - Cookbooks:
- About: cookbooks/index.md - About: cookbooks/index.md
- Blog Posts: cookbooks/blog-posts.md - Blog Posts: cookbooks/blog-posts.md
- Add a new cookbook: cookbooks/contributing.md - Add a new cookbook: cookbooks/contributing.md
- cookbooks/private-monorepo-public-release.md - cookbooks/private-monorepo-public-release.md
- cookbooks/multi-platform-docker-images.md - cookbooks/multi-platform-docker-images.md
- cookbooks/build-go-modules.md - cookbooks/build-go-modules.md
- cookbooks/cgo-and-crosscompiling.md - cookbooks/cgo-and-crosscompiling.md
- cookbooks/debconf-templates.md - cookbooks/debconf-templates.md
- cookbooks/using-jfrog-cli-to-publish-to-artifactory.md - cookbooks/using-jfrog-cli-to-publish-to-artifactory.md
- cookbooks/publish-to-nexus.md - cookbooks/publish-to-nexus.md
- cookbooks/release-a-library.md - cookbooks/release-a-library.md
- cookbooks/semantic-release.md - cookbooks/semantic-release.md
- cookbooks/set-a-custom-git-tag.md - cookbooks/set-a-custom-git-tag.md
- cookbooks/using-main.version.md - cookbooks/using-main.version.md
- cookbooks/override-image-name.md - cookbooks/override-image-name.md
- cookbooks/goreleaser-xx.md - cookbooks/goreleaser-xx.md
- Community: - Community:
- sponsors.md - sponsors.md
- users.md - users.md
- contributing.md - contributing.md
- pro.md - pro.md
- links.md - links.md
markdown_extensions: markdown_extensions:
- admonition - admonition