search

JuliaLang / StyledStrings.jl

Write with ✨ style ✨ and ease
https://julialang.github.io/StyledStrings.jl/
MIT License
25 stars 10 forks source link

Register StyledStrings.jl 1.0 in general #5

Closed tecosaur closed 6 months ago

tecosaur commented 1 year ago

As of JuliaLang/julia#49586 we have the StyledStrings stdlib. Thanks to it being an external stlib, we can also register it in General.

I think we can be a bit sneakier though, and do the following:

I think we want to do this just before 1.11, so the registered 1.0 version behaves as near-identically as possible. This issue is mainly to serve as a tracked reminder for me to do so.

KristofferC commented 1 year ago

To me, you would just register this 1.0 compatible version from a branch. No need to revert anything, or?

I don't really see how this is a release blocker.

This issue is mainly to serve as a tracked reminder for me to do so.

Maybe this is more suitable for the StyledStrings.jl repo?

tecosaur commented 1 year ago

Ah yep, I suppose this could be a branch.

In my mind, the timing here should line up with the 1.11 release, but I suppose that actually isn't a hard requirement.

Happy to close + create a new issue there, or for you to just transfer this issue (I can't).

tecosaur commented 1 year ago

Support for 1.0 is now a work in progress over at https://github.com/julialang/StyledStrings.jl/tree/julia1-compat

zsz00 commented 11 months ago

Hope to register this package ASAP @tecosaur

tecosaur commented 11 months ago

The current plan is to register this around the Julia 1.11 release, so that 1.0 can be as "up to date" as possible, since past that release my plan is to only push bugfixes to pre-1.11.

kimikage commented 6 months ago

@tecosaur Why wait for v1.0 (or v1.11) in the first place? Why not register v0.x with a minimal stuff? That is a package management issue, and no one should be offended if it doesn't work (as long as it successfully gets compiled) or if there are specification discrepancies with v1.

Julia v1.11.0 is already in the beta testing phase, but the (weak) dependent packages are in trouble with testing.

In general terms, there is no need to register v0.x. Also, since this is a community project, I don't think any particular individual should be held responsible for that. However, I do think you have a responsibility to register this package ASAP.

I understand that I am being rude. However, I don't think you are getting my intent. https://github.com/JuliaGraphics/ColorTypes.jl/pull/302#issue-2263085159

tecosaur commented 6 months ago

Why wait for v1.0 (or v1.11) in the first place?

I see it as rather important that the compat-registered version of StyledStrings mirrors the version in 1.11 as closely as possible.

Rather crucially, the compat version also needs to vendor the new AnnotatedString functionality from Base.

Currently there are three changes that I'm trying to get reviewed and merged for 1.11:

Julia v1.11.0 is already in the beta testing phase, but the (weak) dependent packages are in trouble with testing.

I do sympathise with this, I'm just not sure if quickly releasing something so that package management is happy is the right approach?

Perhaps I'm just slightly caught by the sunk cost fallacy, but it feels to me that the code that will be in 1.11 is so very close to ironed down that it might be best to wait the just a little longer :crossed_fingers: to be able to register the "fully mirrors the functionality in 1.11" version.

kimikage commented 6 months ago

It is up to the package to determine if the incomplete StyledStrings are compatible with the package, so it should not matter how compatible it is with v1.11. It is possible to have conditional branching for compatibility in the package. However, the problem is at the stage of installing packages.

In any case, you are the one who knows best about this library. So, v0.x registration probably should not take place.

tecosaur commented 6 months ago

This process has been dragging on a bit. I'll tell you what, I'll see if I can't get the items I listed sorted within a week or so, and then make the aforementioned 1.0 release.

If not I'm willing to re-evaluate the idea of a pre-release just so weakdeps are resolvable.

tecosaur commented 6 months ago

Update: we're reaching the end of the week and ... it's all been merged!

Now I just need to backport/grab the changes, make sure all the tests still pass on older version, and then we'll have the compat release I've been talking along for so long :grinning:

tecosaur commented 6 months ago

The compat version is about to be registered :slightly_smiling_face: