go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-03-11 14:39:28 +02:00
Code Issues Releases Activity

docs: formatting

Browse Source 
Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com>
This commit is contained in:
Carlos Alexandro Becker 2021-04-22 10:58:58 -03:00
parent 29cb60330b
commit d822baf11f
No known key found for this signature in database
GPG Key ID: E61E2F7DC14AB940
4 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
cmd/build.go
View File

@ -41,6 +41,12 @@ func newBuildCmd() *buildCmd {
Use: "build",
Aliases: []string{"b"},
Short: "Builds the current project",
Long: `The build command allows you to execute only a subset of the pipeline, i.e. only the build step with its dependencies.
It allows you to quickly check if your GoReleaser build configurations are doing what you expect.
Finally, it allows you to generate a local build for your current machine only using the `+ "`--single-target`"+` option, and specific build IDs using the `+"`--id`"+` option.
`,
SilenceUsage: true,
SilenceErrors: true,
Args: cobra.NoArgs,
@ -64,7 +70,7 @@ func newBuildCmd() *buildCmd {
}
cmd.Flags().StringVarP(&root.opts.config, "config", "f", "", "Load configuration from file")
cmd.Flags().BoolVar(&root.opts.snapshot, "snapshot", false, "Generate an unversioned snapshot build, skipping all validations and without publishing any artifacts")
cmd.Flags().BoolVar(&root.opts.snapshot, "snapshot", false, "Generate an unversioned snapshot build, skipping all validations")
cmd.Flags().BoolVar(&root.opts.skipValidate, "skip-validate", false, "Skips several sanity checks")
cmd.Flags().BoolVar(&root.opts.skipPostHooks, "skip-post-hooks", false, "Skips all post-build hooks")
cmd.Flags().BoolVar(&root.opts.rmDist, "rm-dist", false, "Remove the dist folder before building")

2
cmd/completion.go
View File

@ -49,8 +49,6 @@ To load completions for each session, execute once:
$ goreleaser completion fish > ~/.config/fish/completions/goreleaser.fish
**NOTE**: If you are using an official GoReleaser package, it should setup autocompletions for you out of the box.
### Usage
`,
SilenceUsage: true,
DisableFlagsInUseLine: true,

11
www/docs/cmd/goreleaser_build.md
View File

@ -2,6 +2,15 @@
Builds the current project
## Synopsis
The build command allows you to execute only a subset of the pipeline, i.e. only the build step with its dependencies.
It allows you to quickly check if your GoReleaser build configurations are doing what you expect.
Finally, it allows you to generate a local build for your current machine only using the `--single-target` option, and specific build IDs using the `--id` option.
```
goreleaser build [flags]
```
@ -17,7 +26,7 @@ goreleaser build [flags]
--single-target Builds only for current GOOS and GOARCH
--skip-post-hooks Skips all post-build hooks
--skip-validate Skips several sanity checks
--snapshot Generate an unversioned snapshot build, skipping all validations and without publishing any artifacts
--snapshot Generate an unversioned snapshot build, skipping all validations
--timeout duration Timeout to the entire build process (default 30m0s)
```

2
www/docs/cmd/goreleaser_completion.md
View File

@ -43,8 +43,6 @@ To load completions for each session, execute once:
**NOTE**: If you are using an official GoReleaser package, it should setup autocompletions for you out of the box.
## Usage
```
goreleaser completion [bash|zsh|fish]