go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2024-12-27 01:33:39 +02:00
Code Issues Releases Activity

docs: improve brew and krew docs

Browse Source 
Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>
This commit is contained in:
Carlos Alexandro Becker 2023-05-19 14:25:59 +00:00
parent 27f94523c8
commit 7da18ec8f4
No known key found for this signature in database
GPG Key ID: E61E2F7DC14AB940
2 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -59,12 +59,13 @@ brews:
# 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.
@ -89,6 +90,8 @@ brews:
# 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
@ -98,6 +101,8 @@ brews:
# 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`.
@ -105,6 +110,7 @@ brews:
# 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).
@ -154,6 +160,8 @@ brews:
# leaving the responsibility of publishing it to the user.
# If set to auto, the release will not be uploaded to the homebrew tap
# in case there is an indicator for prerelease in the tag e.g. v1.0.0-rc1
#
# Templates: allowed
skip_upload: true
# Custom block for brew.

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

@ -14,6 +14,7 @@ krews:
# Name of the recipe
#
# Default: ProjectName
# Templates: allowed
name: myproject
# IDs of the archives to use.
@ -59,6 +60,7 @@ krews:
# 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.
@ -83,6 +85,8 @@ krews:
# 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
@ -92,6 +96,8 @@ krews:
# 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`.
@ -99,6 +105,7 @@ krews:
# 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
@ -107,6 +114,7 @@ krews:
# GitHub: 'https://github.com/<repo_owner>/<repo_name>/releases/download/{{ .Tag }}/{{ .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 }}'
# Templates: allowed
url_template: "http://github.mycompany.com/foo/bar/releases/{{ .Tag }}/{{ .ArtifactName }}"
# Git author used to commit to the repository.