Skip to content

update yank section #36

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

update yank section #36

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1c3237
update yank section
rafaqz May 6, 2024
424237a
Update README.md
rafaqz May 6, 2024
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
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,13 @@ Simply releasing a patch for PackageA (v1.1.1) that removes support for v0.4 won
It might seem sufficient to just pin the downstream packages to use v1.0.0, but there may be a lot of them to fix, and you can't be certain you're aware of them all.
It also does nothing to prevent new compatibility issues from arising in the future.

To fix this, you should still release a patch of PackageA (v1.1.1) that removes support for v0.4 of PackageB, but you should then mark v1.1.0 of PackageA as broken in the registry.
To fix this, you should still release a patch of PackageA (v1.1.1) that removes support for v0.4 of PackageB, and also remove the compatability from
Compat.toml for the package in the general registry. This should require changing two compat bounds - removing the julia version from the package
version that will not work with it, and adding the package version to the julia version it is in fact compatible with.

In some circumstances (help needed to elaborate here) it may still be necessary to yank a package version, for example where it does not
work on any Julia version at all and a bumping a minor version will not prevent it being loaded by some julia versions.

To do this, simply make a PR to the registry, adding `yanked = true` to the `Version.toml` file under the version causing issues (in this case v1.1.0).
This marks the release as broken and prevents it from being used by any package from then on.

Expand Down