1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-04-15 11:56:56 +02:00

docs: update

Signed-off-by: Carlos A Becker <caarlos0@gmail.com>
This commit is contained in:
Carlos A Becker 2021-12-21 16:14:20 -03:00
parent 1d13d6a776
commit 386a6f3709
No known key found for this signature in database
GPG Key ID: E61E2F7DC14AB940
7 changed files with 48 additions and 34 deletions

View File

@ -26,7 +26,7 @@ single .goreleaser.yml file.
* [goreleaser build](/cmd/goreleaser_build/) - Builds the current project * [goreleaser build](/cmd/goreleaser_build/) - Builds the current project
* [goreleaser check](/cmd/goreleaser_check/) - Checks if configuration is valid * [goreleaser check](/cmd/goreleaser_check/) - Checks if configuration is valid
* [goreleaser completion](/cmd/goreleaser_completion/) - generate the autocompletion script for the specified shell * [goreleaser completion](/cmd/goreleaser_completion/) - Generate the autocompletion script for the specified shell
* [goreleaser init](/cmd/goreleaser_init/) - Generates a .goreleaser.yaml file * [goreleaser init](/cmd/goreleaser_init/) - Generates a .goreleaser.yaml file
* [goreleaser jsonschema](/cmd/goreleaser_jsonschema/) - outputs goreleaser's JSON schema * [goreleaser jsonschema](/cmd/goreleaser_jsonschema/) - outputs goreleaser's JSON schema
* [goreleaser release](/cmd/goreleaser_release/) - Releases the current project * [goreleaser release](/cmd/goreleaser_release/) - Releases the current project

View File

@ -1,10 +1,9 @@
# goreleaser completion # goreleaser completion
generate the autocompletion script for the specified shell Generate the autocompletion script for the specified shell
## Synopsis ## Synopsis
Generate the autocompletion script for goreleaser for the specified shell. Generate the autocompletion script for goreleaser for the specified shell.
See each sub-command's help for details on how to use the generated script. See each sub-command's help for details on how to use the generated script.
@ -24,8 +23,8 @@ See each sub-command's help for details on how to use the generated script.
## See also ## See also
* [goreleaser](/cmd/goreleaser/) - Deliver Go binaries as fast and easily as possible * [goreleaser](/cmd/goreleaser/) - Deliver Go binaries as fast and easily as possible
* [goreleaser completion bash](/cmd/goreleaser_completion_bash/) - generate the autocompletion script for bash * [goreleaser completion bash](/cmd/goreleaser_completion_bash/) - Generate the autocompletion script for bash
* [goreleaser completion fish](/cmd/goreleaser_completion_fish/) - generate the autocompletion script for fish * [goreleaser completion fish](/cmd/goreleaser_completion_fish/) - Generate the autocompletion script for fish
* [goreleaser completion powershell](/cmd/goreleaser_completion_powershell/) - generate the autocompletion script for powershell * [goreleaser completion powershell](/cmd/goreleaser_completion_powershell/) - Generate the autocompletion script for powershell
* [goreleaser completion zsh](/cmd/goreleaser_completion_zsh/) - generate the autocompletion script for zsh * [goreleaser completion zsh](/cmd/goreleaser_completion_zsh/) - Generate the autocompletion script for zsh

View File

@ -1,23 +1,27 @@
# goreleaser completion bash # goreleaser completion bash
generate the autocompletion script for bash Generate the autocompletion script for bash
## Synopsis ## Synopsis
Generate the autocompletion script for the bash shell. Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package. This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager. If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session: To load completions in your current shell session:
$ source <(goreleaser completion bash)
source <(goreleaser completion bash)
To load completions for every new session, execute once: To load completions for every new session, execute once:
Linux:
$ goreleaser completion bash > /etc/bash_completion.d/goreleaser ### Linux:
MacOS:
$ goreleaser completion bash > /usr/local/etc/bash_completion.d/goreleaser goreleaser completion bash > /etc/bash_completion.d/goreleaser
### macOS:
goreleaser completion bash > /usr/local/etc/bash_completion.d/goreleaser
You will need to start a new shell for this setup to take effect. You will need to start a new shell for this setup to take effect.
@ -41,5 +45,5 @@ goreleaser completion bash
## See also ## See also
* [goreleaser completion](/cmd/goreleaser_completion/) - generate the autocompletion script for the specified shell * [goreleaser completion](/cmd/goreleaser_completion/) - Generate the autocompletion script for the specified shell

View File

@ -1,17 +1,18 @@
# goreleaser completion fish # goreleaser completion fish
generate the autocompletion script for fish Generate the autocompletion script for fish
## Synopsis ## Synopsis
Generate the autocompletion script for the fish shell. Generate the autocompletion script for the fish shell.
To load completions in your current shell session: To load completions in your current shell session:
$ goreleaser completion fish | source
goreleaser completion fish | source
To load completions for every new session, execute once: To load completions for every new session, execute once:
$ goreleaser completion fish > ~/.config/fish/completions/goreleaser.fish
goreleaser completion fish > ~/.config/fish/completions/goreleaser.fish
You will need to start a new shell for this setup to take effect. You will need to start a new shell for this setup to take effect.
@ -35,5 +36,5 @@ goreleaser completion fish [flags]
## See also ## See also
* [goreleaser completion](/cmd/goreleaser_completion/) - generate the autocompletion script for the specified shell * [goreleaser completion](/cmd/goreleaser_completion/) - Generate the autocompletion script for the specified shell

View File

@ -1,14 +1,14 @@
# goreleaser completion powershell # goreleaser completion powershell
generate the autocompletion script for powershell Generate the autocompletion script for powershell
## Synopsis ## Synopsis
Generate the autocompletion script for powershell. Generate the autocompletion script for powershell.
To load completions in your current shell session: To load completions in your current shell session:
PS C:\> goreleaser completion powershell | Out-String | Invoke-Expression
goreleaser completion powershell | Out-String | Invoke-Expression
To load completions for every new session, add the output of the above command To load completions for every new session, add the output of the above command
to your powershell profile. to your powershell profile.
@ -33,5 +33,5 @@ goreleaser completion powershell [flags]
## See also ## See also
* [goreleaser completion](/cmd/goreleaser_completion/) - generate the autocompletion script for the specified shell * [goreleaser completion](/cmd/goreleaser_completion/) - Generate the autocompletion script for the specified shell

View File

@ -1,22 +1,25 @@
# goreleaser completion zsh # goreleaser completion zsh
generate the autocompletion script for zsh Generate the autocompletion script for zsh
## Synopsis ## Synopsis
Generate the autocompletion script for the zsh shell. Generate the autocompletion script for the zsh shell.
If shell completion is not already enabled in your environment you will need If shell completion is not already enabled in your environment you will need
to enable it. You can execute the following once: to enable it. You can execute the following once:
$ echo "autoload -U compinit; compinit" >> ~/.zshrc echo "autoload -U compinit; compinit" >> ~/.zshrc
To load completions for every new session, execute once: To load completions for every new session, execute once:
# Linux:
$ goreleaser completion zsh > "${fpath[1]}/_goreleaser" ### Linux:
# macOS:
$ goreleaser completion zsh > /usr/local/share/zsh/site-functions/_goreleaser goreleaser completion zsh > "${fpath[1]}/_goreleaser"
### macOS:
goreleaser completion zsh > /usr/local/share/zsh/site-functions/_goreleaser
You will need to start a new shell for this setup to take effect. You will need to start a new shell for this setup to take effect.
@ -40,5 +43,5 @@ goreleaser completion zsh [flags]
## See also ## See also
* [goreleaser completion](/cmd/goreleaser_completion/) - generate the autocompletion script for the specified shell * [goreleaser completion](/cmd/goreleaser_completion/) - Generate the autocompletion script for the specified shell

9
www/docs/static/schema-pro.json generated vendored
View File

@ -391,7 +391,14 @@
"type": "boolean" "type": "boolean"
}, },
"use": { "use": {
"type": "string" "enum": [
"git",
"github",
"github-native",
"gitlab"
],
"type": "string",
"default": "git"
}, },
"groups": { "groups": {
"items": { "items": {