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.

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

Update docs on renaming existing package #40171

Merged
merged 2 commits into from
Jul 3, 2021
Merged

Update docs on renaming existing package #40171

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3993a89
Update docs on renaming existing package
ericphanson Jul 3, 2021
13bcd3a
Update README.md
ericphanson Jul 3, 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
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,13 @@ As long as the package is not yet registered, renaming the package from
#### How do I rename an existing registered package?

Technically, you can't rename a package once registered, as this would break existing users.
But you can re-register the package again under a new name with a new UUID.
Which has basically the same effect.
But you can re-register the package again under a new name with a new UUID, which basically
has the same effect.

- Follow the instructions above for renaming a package: rename on GitHub, rename files etc.
- if you rename the repository so it has a new URL, make a PR to edit the URL stored in the
registry for the old package name to point to the new URL ([example](https://github.com/JuliaRegistries/General/pull/40190/files)).
This allows the old versions of the package under the previous name to continue to work.
- Generate a new UUID for the Project.toml
- Increment the version in the Project.toml as a breaking change.
- [Register](#registering-a-package-in-general) it as if it were a new package
Expand Down