Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: version recent changes #3367

Merged
merged 3 commits into from Sep 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 2 additions & 0 deletions www/docs/customization/announce/webhook.md
@@ -1,5 +1,7 @@
# Webhook

Since: v1.3.

Webhooks are a way to receive notifications. With this `Goreleaser` functionality, you can send events to any server
exposing a webhook.

Expand Down
7 changes: 5 additions & 2 deletions www/docs/customization/archive.md
Expand Up @@ -27,7 +27,9 @@ archives:

# This will create an archive without any binaries, only the files are there.
# The name template must not contain any references to `Os`, `Arch` and etc, since the archive will be meta.
# Default is false.
#
# Default: false.
# Since: v1.9.
meta: true

# Archive name template.
Expand Down Expand Up @@ -60,7 +62,8 @@ archives:
#
# This might be useful if you have your binary be built with a subdir for some reason, but do no want that subdir inside the archive.
#
# Default is false.
# Default: false.
# Since: v1.11.
strip_parent_binary_folder: true

# Can be used to change the archive formats for specific GOOSs.
Expand Down
5 changes: 4 additions & 1 deletion www/docs/customization/artifactory.md
Expand Up @@ -147,7 +147,9 @@ artifactories:
# This might be useful if you have multiple packages with different
# extensions with the same ID, and need to upload each extension to
# a different place (e.g. nFPM packages).
# Default is empty.
#
# Default: empty.
# Since: v1.7.
exts:
- deb
- rpm
Expand All @@ -165,6 +167,7 @@ artifactories:
username: deployuser

# Client certificate and key (when provided, added as client cert to TLS connections)
# Since: v1.11.
client_x509_cert: /path/to/client.cert.pem
client_x509_key: /path/to/client.key.pem

Expand Down
2 changes: 2 additions & 0 deletions www/docs/customization/aur.md
@@ -1,5 +1,7 @@
# Arch User Repositories

Since: v1.4.

After releasing to GitHub or GitLab, GoReleaser can generate and publish
a `PKGBUILD` to an _Arch User Repository_.

Expand Down
15 changes: 9 additions & 6 deletions www/docs/customization/build.md
Expand Up @@ -116,8 +116,8 @@ builds:
# Format is `{goos}_{goarch}` with optionally a suffix with `_{goarm}`, `_{goamd64}` or `_{gomips}`.
#
# Special values:
# - go_118_first_class: evaluates to the first-class targets of go1.18
# - go_first_class: evaluates to latest stable go first-class targets, currently same as 1.18.
# - go_118_first_class: evaluates to the first-class targets of go1.18. Since GoReleaser v1.9.
# - go_first_class: evaluates to latest stable go first-class targets, currently same as 1.18. Since GoReleaser v1.9.
#
# This overrides `goos`, `goarch`, `goarm`, `gomips`, `goamd64` and `ignores`.
targets:
Expand All @@ -138,7 +138,8 @@ builds:
# in which case you can set this to "test".
# It is safe to ignore this option in most cases.
#
# Default is "build".
# Default: build.
# Since: v1.9.
command: test

# Set the modified timestamp on the output binary, typically
Expand Down Expand Up @@ -172,7 +173,8 @@ builds:
# By default, GoReleaser will check if the main filepath has a main function.
# This can be used to skip that check, in case you're building tests, for example.
#
# Defaults to `false`.
# Default: false.
# Since: v1.9.
no_main_check: true

# Path to project's (sub)directory containing Go code.
Expand All @@ -193,7 +195,8 @@ builds:
# This can be specially useful when using CGO.
# Note: it'll only match if the full target matches.
#
# Defaults to empty.
# Default: empty.
# Since: v1.5.
overrides:
- goos: darwin
goarch: arm64
Expand Down Expand Up @@ -320,7 +323,7 @@ builds:
pre:
- cmd: first-script.sh
dir: "{{ dir .Dist}}"
output: true # always print command output, otherwise only visible in debug mode
output: true # always print command output, otherwise only visible in debug mode. Since GoReleaser v1.5.
env:
- HOOK_SPECIFIC_VAR={{ .Env.GLOBAL_VAR }}
- second-script.sh
Expand Down
3 changes: 2 additions & 1 deletion www/docs/customization/changelog.md
Expand Up @@ -33,7 +33,8 @@ changelog:
# -1: remove the commit hash from the changelog
# any other number: max length.
#
# Default is 0.
# Default: 0.
# Since: v1.11.2
abbrev: -1

# Group commits messages by given regex and title.
Expand Down
3 changes: 2 additions & 1 deletion www/docs/customization/docker_sign.md
Expand Up @@ -65,7 +65,8 @@ docker_signs:
# By default, the stdout and stderr of the signing cmd are discarded unless GoReleaser is running with `--debug` set.
# You can set this to true if you want them to be displayed regardless.
#
# Defaults to false
# Default: false.
# Since: v1.2.
output: true
```

Expand Down
2 changes: 2 additions & 0 deletions www/docs/customization/homebrew.md
Expand Up @@ -133,6 +133,8 @@ brews:
...

# Service block.
#
# Since: v1.7.
service: |
run: foo/bar
...
Expand Down
2 changes: 1 addition & 1 deletion www/docs/customization/hooks.md
Expand Up @@ -38,7 +38,7 @@ GoReleaser allows this with the global hooks feature.
- make clean # simple string
- cmd: go generate ./... # specify cmd
- cmd: go mod tidy
output: true # always prints command output
output: true # always prints command output. Since GoReleaser v1.5.
dir: ./submodule # specify command working directory
- cmd: touch {{ .Env.FILE_TO_TOUCH }}
env:
Expand Down
5 changes: 4 additions & 1 deletion www/docs/customization/nfpm.md
Expand Up @@ -66,14 +66,15 @@ nfpms:
- apk
- deb
- rpm
- termux.deb
- termux.deb # Since GoReleaser v1.11.

# Packages your package depends on. (overridable)
dependencies:
- git
- zsh

# Packages it provides. (overridable)
# Since: v1.11.
provides:
- bar

Expand Down Expand Up @@ -135,6 +136,8 @@ nfpms:
# formats (deb and rpm at the moment).
#
# Experimental.
# Default: empty.
# Since: v1.11.
changelog: ./foo.yml

# Contents to add to the package.
Expand Down
11 changes: 8 additions & 3 deletions www/docs/customization/release.md
Expand Up @@ -31,14 +31,18 @@ release:
# Whether to remove existing draft releases with the same name before creating a new one.
# Only effective if `draft` is set to true.
# Available only for GitHub.
# Default is false.
#
# Default: false.
# Since: v1.11.
replace_existing_draft: true

# Useful if you want to delay the creation of the tag in the remote.
# You can create the tag locally, but not push it, and run GoReleaser.
# It'll then set the `target_commitish` portion of the GitHub release to the value of this field.
# Only works on GitHub.
# Default is empty.
#
# Default: empty.
# Since: v1.11.
target_commitish: '{{ .Commit }}'

# If set, will create a release discussion in the category specified.
Expand Down Expand Up @@ -93,7 +97,8 @@ release:
# Set this to true if you want to disable just the artifact upload to the SCM.
# If this is true, GoReleaser will still create the release with the changelog, but won't upload anything to it.
#
# Defaults to false.
# Default: false.
# Since: v1.11.
skip_upload: true

# You can add extra pre-existing files to the release.
Expand Down
2 changes: 2 additions & 0 deletions www/docs/customization/sbom.md
@@ -1,5 +1,7 @@
# Cataloging artifacts

Since: v1.2.

A Software Bill of Materials (SBOM) is a description of the components that make up a software artifact.

Goreleaser can create one or more SBOMs for any artifacts generated by Goreleaser.
Expand Down
3 changes: 2 additions & 1 deletion www/docs/customization/sign.md
Expand Up @@ -101,7 +101,8 @@ signs:
# By default, the stdout and stderr of the signing cmd are discarded unless GoReleaser is running with `--debug` set.
# You can set this to true if you want them to be displayed regardless.
#
# Defaults to false
# Default: false.
# Since: v1.2.
output: true
```

Expand Down