From ad2986a2e1334b19f3f33522db8fdeefcd5b1c58 Mon Sep 17 00:00:00 2001 From: Carlos A Becker Date: Sat, 25 Jun 2022 16:42:11 -0300 Subject: [PATCH] docs: update Signed-off-by: Carlos A Becker --- www/docs/cmd/goreleaser_announce.md | 41 +++++++++++++++++++++++++++++ www/docs/cmd/goreleaser_publish.md | 41 +++++++++++++++++++++++++++++ 2 files changed, 82 insertions(+) create mode 100644 www/docs/cmd/goreleaser_announce.md create mode 100644 www/docs/cmd/goreleaser_publish.md diff --git a/www/docs/cmd/goreleaser_announce.md b/www/docs/cmd/goreleaser_announce.md new file mode 100644 index 000000000..475451348 --- /dev/null +++ b/www/docs/cmd/goreleaser_announce.md @@ -0,0 +1,41 @@ +# goreleaser announce + +Announces a previously prepared release + +## Synopsis + +If you have a previously prepared release with `goreleaser release --prepare` and published it with `goreleaser publish`, you can use this command to announce it. + +The idea is to prepare a release without publishing anything, assert the artifacts are correct (either automatically or not), publish it, and then, finally, announce it to your users. + +Environment variables will be re-evaluated here, so make sure they are available to the announce command as well. + +!!! success "GoReleaser Pro" + This subcommand is [GoReleaser Pro feature](https://goreleaser.com/pro/). + + +``` +goreleaser announce [flags] +``` + +## Options + +``` + -d, --dist string dist folder to continue (default "./dist") + -h, --help help for announce + -k, --key string GoReleaser Pro license key [$GORELEASER_KEY] + -p, --parallelism int Amount tasks to run concurrently (default: number of CPUs) + --skip-after Skips global after hooks + --timeout duration Timeout to the entire announce process (default 30m0s) +``` + +## Options inherited from parent commands + +``` + --debug Enable debug mode +``` + +## See also + +* [goreleaser](/cmd/goreleaser/) - Deliver Go binaries as fast and easily as possible + diff --git a/www/docs/cmd/goreleaser_publish.md b/www/docs/cmd/goreleaser_publish.md new file mode 100644 index 000000000..455bba4c6 --- /dev/null +++ b/www/docs/cmd/goreleaser_publish.md @@ -0,0 +1,41 @@ +# goreleaser publish + +Publishes a previously prepared release + +## Synopsis + +If you have a previously prepared release (run with `goreleaser release --prepare`), you can use this command to publish it. + +The idea is to prepare a release without publishing anything, assert the artifacts are correct (either automatically or not), and then, finally, publish the release and its artifacts. + +Environment variables will be re-evaluated here, so make sure they are available to the publish command as well. + +!!! success "GoReleaser Pro" + This subcommand is [GoReleaser Pro feature](https://goreleaser.com/pro/). + + +``` +goreleaser publish [flags] +``` + +## Options + +``` + -d, --dist string dist folder to continue (default "./dist") + -h, --help help for publish + -k, --key string GoReleaser Pro license key [$GORELEASER_KEY] + -p, --parallelism int Amount tasks to run concurrently (default: number of CPUs) + --skip-after Skips global after hooks + --timeout duration Timeout to the entire publish process (default 30m0s) +``` + +## Options inherited from parent commands + +``` + --debug Enable debug mode +``` + +## See also + +* [goreleaser](/cmd/goreleaser/) - Deliver Go binaries as fast and easily as possible +