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

Slim down project upgrade output #1191

Merged
merged 2 commits into from
Dec 19, 2023
Merged

Conversation

Dhghomon
Copy link
Contributor

@Dhghomon Dhghomon commented Dec 18, 2023

Resolves #1190

First took a look at getting the multiline-into-single line issue solved through the attributes that clap (Rust's command-line parser) has, but on second look there's no info there that isn't contained in the options below, except for one example of an argument when moving to a specific version. So outright deleting this legacy comment seems best.

(As always, feel free to suggest a rewording)

Changes the output from this:

Upgrade EdgeDB instance used for current project

This command has two modes of operation.

Upgrade instance to version specified in `edgedb.toml`:

project upgrade

Update `edgedb.toml` to new version and upgrade the instance:

project upgrade --to-latest project upgrade --to-version=1-beta2 project upgrade --to-nightly

In all cases your data is preserved and converted using dump/restore mechanism. May fail if lower
version is specified (e.g. if upgrading from nightly to stable).

Usage: edgedb.exe project upgrade [OPTIONS]

Options:
      --project-dir <PROJECT_DIR>
          Explicitly set a root directory for the project

      --to-latest
          Upgrade specified instance to latest version

      --to-version <TO_VERSION>
          Upgrade specified instance to a specified version

      --to-nightly
          Upgrade specified instance to latest nightly version

      --to-testing
          Upgrade specified instance to latest testing version

      --to-channel <TO_CHANNEL>
          Upgrade specified instance to the specified channel

          [possible values: stable, testing, nightly]

  -v, --verbose
          Verbose output

      --force
          Force upgrade process even if there is no new version

      --non-interactive
          Do not ask questions, assume user wants to upgrade instance

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

to this

Upgrade EdgeDB instance used for current project

Data is preserved using a dump/restore mechanism.

Upgrades to version specified in `edgedb.toml` unless other options specified.

Note: May fail if lower version is specified (e.g. moving from nightly to stable).

Usage: edgedb.exe project upgrade [OPTIONS]

Options:
      --project-dir <PROJECT_DIR>
          Explicitly set a root directory for the project

      --to-latest
          Upgrade specified instance to latest version

      --to-version <TO_VERSION>
          Upgrade specified instance to a specified version.

          e.g. --to-version=4.0-beta.1

      --to-nightly
          Upgrade specified instance to latest nightly version

      --to-testing
          Upgrade specified instance to latest testing version

      --to-channel <TO_CHANNEL>
          Upgrade specified instance to the specified channel

          [possible values: stable, testing, nightly]

  -v, --verbose
          Verbose output

      --force
          Force upgrade process even if there is no new version

      --non-interactive
          Do not ask questions, assume user wants to upgrade instance

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

@Dhghomon Dhghomon marked this pull request as ready for review December 18, 2023 05:44
@Dhghomon Dhghomon requested a review from raddevon December 18, 2023 05:44
Copy link
Contributor

@raddevon raddevon left a comment

Choose a reason for hiding this comment

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

Looks good! I provided one tiny suggestion.

src/portable/project.rs Outdated Show resolved Hide resolved
Co-authored-by: Devon Campbell <[email protected]>
@Dhghomon Dhghomon merged commit f6783e8 into master Dec 19, 2023
16 checks passed
@Dhghomon Dhghomon deleted the slim-down-project-upgrate-output branch December 19, 2023 06:21
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.

Multiple edgedb project upgrade command examples are output on a single line
2 participants