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

dist rename rollout plan #1481

Open
6 of 11 tasks
mistydemeo opened this issue Oct 23, 2024 · 1 comment
Open
6 of 11 tasks

dist rename rollout plan #1481

mistydemeo opened this issue Oct 23, 2024 · 1 comment

Comments

@mistydemeo
Copy link
Contributor

mistydemeo commented Oct 23, 2024

In #1267, we're working towards renaming cargo-dist to dist. We have a few steps to do in this release and in the releases to follow.

Now

  • Replace all user-facing references to cargo-dist with dist, except in the names of the installers and related packages
  • Thoroughly test the new dist binary and its cargo-dist alias, ensuring it works both ways
  • Update the documentation with the new name
  • Write a blog post announcing the new name

When 0.24.0 is released

  • Publish doc changes
  • Publish blog post

After 0.24.0 is released

  • Prepare to rename the package so that future installers use the name dist instead of cargo-dist
  • Ensure the Homebrew package can retain its name for compatibility OR use a Homebrew tap rename to handle the Homebrew name change
  • Decide how to handle crates.io package name changes
  • Cut a minor release with these changes

Sometime after that minor release

  • Cut a release under the new package name, so the intermediate release has a package to upgrade to
@mistydemeo
Copy link
Contributor Author

The rename infrastructure is available in #1647. The actual rename is in #1648.

I've tested out the rename in a fork of cargo-dist using the content of those two PRs. I staged the rename over several versions.

In tests, 0.91.0 can upgrade to 0.92.0 as expected. 0.92.0 can then upgrade to either 0.100.0 or 0.101.0 safely. The new version installs a new receipt under the new name.

So, in other words, I think we can safely do this in two releases:

Here's a sample of the formula rename: mistydemeo/homebrew-cargodisttest@64ac747

We just need to delete the Formula/cargo-dist.rb version and add the formula_renames.json file. Then, Homebrew will just go ahead and use the new formula file generated by dist and will be able to apply upgrades.

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

No branches or pull requests

1 participant