Skip to content

docs: build.go suggested edits for optional --release flag #1240

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Jun 15, 2021
Merged

docs: build.go suggested edits for optional --release flag #1240

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3d306be
suggested edits for the awesome release command
Jun 11, 2021
6a6df55
Update starport/cmd/build.go
Jun 14, 2021
ba6eabd
Merge branch 'develop' into build.go-PR1237-edit
Jun 14, 2021
c55210b
Apply suggestions from code review
Jun 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions starport/cmd/build.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ const (
func NewBuild() *cobra.Command {
c := &cobra.Command{
Use: "build",
Short: "Build your app",
Long: `By default, build command will build your application's binaries
and add them to your $(go env GOPATH)/bin path.
Short: "Build a node binary",
Long: `By default, build your node binaries
and add the binaries to your $(go env GOPATH)/bin path.

If you want to only build binaries for a release, use the --release flag with
--release.targets (optional). Then, binaries built for chosen targets will appear
in your app's path under release/. You can add any number of targets in GOOS:GOARCH format.
If you don't provide any, a binary will be created for your own machine.
To build binaries for a release, use the --release flag. The app binaries
for one or more specified release targets are built in a release/ dir under the app's
source. Specify the release targets with GOOS:GOARCH build tags.
If the optional --release.targets is not specified, a binary is created for your current environment.

Sample usages:
- starport build
Expand All @@ -37,9 +37,9 @@ Sample usages:
c.Flags().AddFlagSet(flagSetHome())
c.Flags().StringVarP(&appPath, "path", "p", ".", "path of the app")
c.Flags().Bool(flagRelease, false, "build for a release")
c.Flags().StringSliceP(flagReleaseTargets, "t", []string{}, "release targets. only available with use of --release flag")
c.Flags().String(flagReleasePrefix, "", "prefix to be used in tarball names for each target")
c.Flags().Bool(flagRebuildProtoOnce, false, "Enables proto code generation for 3rd party modules. only available without the --release flag")
c.Flags().StringSliceP(flagReleaseTargets, "t", []string{}, "release targets. Available only with --release flag")
c.Flags().String(flagReleasePrefix, "", "tarball prefix for each release target. Available only with --release flag")
c.Flags().Bool(flagRebuildProtoOnce, false, "Enables proto code generation for 3rd party modules. Available only without the --release flag")
c.Flags().BoolP("verbose", "v", false, "Verbose output")
return c
}
Expand Down