Skip to content

Change JuliaSyntaxHighlighting UUID#56852

Merged
DilumAluthge merged 2 commits intoJuliaLang:masterfrom
tecosaur:jsh-uuid-change
Jan 29, 2025
Merged

Change JuliaSyntaxHighlighting UUID#56852
DilumAluthge merged 2 commits intoJuliaLang:masterfrom
tecosaur:jsh-uuid-change

Conversation

@tecosaur
Copy link
Copy Markdown
Member

@tecosaur tecosaur commented Dec 17, 2024

TLDR; I made a silly mistake a while back, and this seems like the least bad option.


Unfortunately during development of the backported version of this stdlib, to avoid potential sysimage issues the UUID was temporarilly changed and I forgot to change it back.

This mistake lead to the backport/compat verison of the package having a different UUID from the in-tree stdlib. Beyond this being an embarassing mistake, it's also a pain because it means that we now have incorrect/invalid manifests.

A small mercy is that 1.12 hasn't been released yet, so the discrepancy currently only affects people using development Julia versions. Changing the UUID here will require these people to regenerate their manifests, but this seems like the lesser of two evils.

Appologies for the hassle all.

Unfortunately during development of the backported version of this
stdlib, to avoid potential sysimage issues the UUID was temporarilly
changed and I forgot to change it back.

This mistake lead to the backport/compat verison of the package having a
different UUID from the in-tree stdlib. Beyond this being an embarassing
mistake, it's also a pain because it means that we now have
incorrect/invalid manifests.

A small mercy is that 1.12 hasn't been released yet, so the discrepancy
currently only affects people using development Julia versions. Changing
the UUID here will require these people to regenerate their manifests,
but this seems like the lesser of too evils.
@inkydragon inkydragon added the stdlib Julia's standard library label Dec 18, 2024
@inkydragon
Copy link
Copy Markdown
Member

@tecosaur Any Update?
Perhaps we should include this in 1.12.

@tecosaur
Copy link
Copy Markdown
Member Author

tecosaur commented Jan 8, 2025

We should, and I'll do exactly that — I've just been travelling recently.

@inkydragon inkydragon added this to the 1.12 milestone Jan 9, 2025
@inkydragon

This comment was marked as outdated.

@tecosaur
Copy link
Copy Markdown
Member Author

As mentioned above, it turns out this is good to go.

@tecosaur tecosaur requested a review from inkydragon January 27, 2025 18:31
Copy link
Copy Markdown
Member

@inkydragon inkydragon left a comment

Choose a reason for hiding this comment

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

LGTM

A quick recap:
We have registered the wrong UUID (ac6e5ff7-) for JuliaSyntaxHighlighting.jl in General.

name = "JuliaSyntaxHighlighting"
uuid = "ac6e5ff7-fb65-4e79-a425-ec3bc9c03011"
repo = "https://github.com/JuliaLang/JuliaSyntaxHighlighting.jl.git"

https://github.com/JuliaRegistries/General/blob/48cba3e8f391da43e7df47264f333c210ced7192/J/JuliaSyntaxHighlighting/Package.toml#L2

To minimize the impact, we chose to make the UUID registered in General the correct one.

So we need to update the UUID in Project.toml of JuliaLang/JuliaSyntaxHighlighting.jl.

dc6e5ff7-* => ac6e5ff7-*

name = "JuliaSyntaxHighlighting"
uuid = "dc6e5ff7-fb65-4e79-a425-ec3bc9c03011"

https://github.com/JuliaLang/JuliaSyntaxHighlighting.jl/blob/19bd57b89c648592155156049addf67e0638eab1/Project.toml#L1C1-L2C46


I'll update this branch to make sure everything works on the latest master branch.

@inkydragon
Copy link
Copy Markdown
Member

I'm going to merge this pr in about a day or two.

Add the merger me tag to attract any potential reviewers.

@inkydragon inkydragon added the merge me PR is reviewed. Merge when all tests are passing label Jan 28, 2025
@DilumAluthge
Copy link
Copy Markdown
Member

I think we need to get this PR in before 1.12 is branched. It would be good if someone else could take a look at this and make sure it looks correct/won't break anything.

@KristofferC Could you review this?

@KristofferC
Copy link
Copy Markdown
Member

KristofferC commented Jan 29, 2025

make sure it looks correct/won't break anything

That is very hard to say, swapping out a UUID like this can be quite traumatic for code loading and Pkg. But worst case you get some weird error and have to regenerate your manifest and the current situation is so bad we have to do this nonetheless.

@DilumAluthge DilumAluthge merged commit c172a64 into JuliaLang:master Jan 29, 2025
@DilumAluthge DilumAluthge removed the merge me PR is reviewed. Merge when all tests are passing label Jan 30, 2025
@felixcremer
Copy link
Copy Markdown

Is there an easy way to regenerate the current manifest file from within julia?

@IanButterworth
Copy link
Copy Markdown
Member

@felixcremer not that I'm aware of.

You have two options:

  1. @tecosaur mentioned that you can switch the UUID out with
sed -i 's/dc6e5ff7-fb65-4e79-a425-ec3bc9c03011/ac6e5ff7-fb65-4e79-a425-ec3bc9c03011/' ~/.julia/environments/v1.12/Manifest.toml
  1. Delete the manifest file and pkg> resolve but that loses versioning state

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

embarrassing-bugfix Whoops! stdlib Julia's standard library

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants