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

Install stellar and soroban CLIs when installing either #1350

Merged
merged 1 commit into from
May 31, 2024
Merged

Conversation

leighmcculloch
Copy link
Member

@leighmcculloch leighmcculloch commented May 31, 2024

What

Install the stellar and soroban CLI binaries when installing either the stellar-cli or soroban-cli crate.

Why

In short this change is being made to improve the developer experience during the rename of the CLI.

The CLI is transitioning from being the Soroban CLI to the Stellar CLI, and with that the binary is also transitioning from being soroban to stellar. It'll take a while for that rename to reverberate through the community, docs, tutorials, video walkthroughs, etc. During that transition period this rename should be a non-event, uninteresting, boring, and zero impact. For an undetermined (read long) period of time both the stellar-cli and soroban-cli crates will be published so that if someone is following an old tutorial or docs in a blog somewhere, the install instructions will continue to work.

This change takes it step further and makes it so that no matter which crate you install, you get both binaries. This is to help the situation where someone reads an install tutorial and installs the soroban-cli, then reads a newer tutorial that uses the stellar binary, they'll find the example commands work because the soroban-cli installed both. We've already had at least one person in the community fall into this situation where they did the reverse and installed the stellar-cli crate then followed a tutorial that used the soroban binary.

Note that it will be possible to identify which crate a binary was installed from, by running the version subcommand. For either binary, the name displayed will be the name of the crate the binary was installed from.

@leighmcculloch leighmcculloch marked this pull request as ready for review May 31, 2024 03:53
@janewang
Copy link
Contributor

I'm working on a PR to rename cli in the dev docs. PR is WIP there.

@janewang janewang self-requested a review May 31, 2024 04:01
@leighmcculloch leighmcculloch enabled auto-merge (squash) May 31, 2024 04:03
@leighmcculloch leighmcculloch merged commit 2994d95 into main May 31, 2024
19 of 20 checks passed
@leighmcculloch leighmcculloch deleted the both branch May 31, 2024 04:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants