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

CLI - Add helptext for --build-options #1853

Merged
merged 1 commit into from
Oct 16, 2024
Merged

CLI - Add helptext for --build-options #1853

merged 1 commit into from
Oct 16, 2024

Conversation

bfops
Copy link
Collaborator

@bfops bfops commented Oct 15, 2024

Description of Changes

Fix #1852.

API and ABI breaking changes

Nope

Expected complexity level and risk

1

Testing

New helptext below. Unfortunately, clap still shows the example using a space, but hopefully the helptext helps.

Usage: spacetime publish [OPTIONS] [name|address]

Arguments:
  [name|address]
          A valid domain or address for this database

Options:
  -c, --delete-data
          When publishing to an existing address, first DESTROY all data associated with the module

      --build-options <build_options>
          Options to pass to the build command, for example --build-options='--skip-println-checks'
          
          [default: ]

  -p, --project-path <project_path>
          The system path (absolute or relative) to the module project
          
          [default: .]

  -b, --bin-path <wasm_file>
          The system path (absolute or relative) to the compiled wasm binary we should publish, instead of building the project.

  -i, --identity <identity>
          The identity that should own the database. If no identity is provided, your default identity will be used.

      --anonymous
          Perform this action with an anonymous identity

  -s, --server <server>
          The nickname, domain name or URL of the server to host the database.

  -y, --yes
          Assume "yes" as answer to all prompts and run non-interactively

  -h, --help
          Print help (see a summary with '-h')

Run `spacetime help publish` for more detailed information.

@bfops bfops marked this pull request as ready for review October 15, 2024 16:44
Copy link
Collaborator

@jdetter jdetter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks excellent, thanks Zeke! 👍

@bfops bfops added this pull request to the merge queue Oct 16, 2024
Merged via the queue into master with commit 576b12e Oct 16, 2024
11 checks passed
@bfops bfops deleted the bfops/build-helptext branch October 18, 2024 19:09
lcodes pushed a commit that referenced this pull request Oct 25, 2024
Co-authored-by: Zeke Foppa <bfops@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

spacetime publish/generate --build-options requires a '=' and is undocumented
2 participants