color.js icon indicating copy to clipboard operation
color.js copied to clipboard

Preparing for v0.5.0 release

Open LeaVerou opened this issue 1 year ago • 24 comments

It has been embarassingly long since our last release. Lots of complaints that fixes are not on npm yet.

I’m opening this issue to see if there are any last minute items we want to get in before releasing a new version. Any PRs you want to try and get merged? Any issues you want to try and get resolved first? (easy and quick things please; we don't want to delay the release even more).

If I don't get a response from you by Wednesday, I’ll assume the answer is "no".

Also, any thoughts on what the next version should be? v0.4.6 or v0.5.0? (remember semver works differently for 0.x.y so the "no API changes in minor versions" doesn't apply).

CC @svgeesus @jgerigmeyer @MysteryBlokHed

LeaVerou avatar Feb 05 '24 21:02 LeaVerou

Makes sense to me, and I don't have any open PRs/issues I want to squeeze in. I didn't get to it last week, but I'm happy to help with the release process. I can take a look at that tomorrow.

I think my leaning would be v0.5.0 given the number and significance of changes, but I don't feel strongly about it.

jgerigmeyer avatar Feb 05 '24 22:02 jgerigmeyer

Any PRs you want to try and get merged? Any issues you want to try and get resolved first?

Not for me; nothing that justifies holding up a release.

svgeesus avatar Feb 05 '24 22:02 svgeesus

No PRs/issues from me. I'd also lean towards v0.5.0 for the version, since it's been a while and there have been a good amount of changes.

MysteryBlokHed avatar Feb 06 '24 02:02 MysteryBlokHed

I'll probably submit a PR for the HSLuv and HPLuv color spaces later tonight or tomorrow. Not sure if you want to wait for those color spaces before issuing a release.

lloydk avatar Feb 06 '24 02:02 lloydk

I'll probably submit a PR for the HSLuv and HPLuv color spaces later tonight or tomorrow. Not sure if you want to wait for those color spaces before issuing a release.

Can't hurt! We can list support as experimental in the release notes, since they won't have been tested much.

LeaVerou avatar Feb 06 '24 18:02 LeaVerou

Makes sense to me, and I don't have any open PRs/issues I want to squeeze in. I didn't get to it last week, but I'm happy to help with the release process. I can take a look at that tomorrow.

I think my leaning would be v0.5.0 given the number and significance of changes, but I don't feel strongly about it.

That would be amazing, as I’m so incredibly swamped.

LeaVerou avatar Feb 07 '24 05:02 LeaVerou

I'll work on preparing a release today. @LeaVerou If you have a chance to take a look at https://github.com/color-js/color.js/pull/407 and https://github.com/color-js/color.js/pull/404, I think we might want to get those in before a release.

Also, given the number of changes I'm tempted to start with a v0.5.0-beta.0 release first, test it out on a few projects, then do a full release tomorrow or Friday. Do you think that's overly cautious, given that we're pre-1.0?

jgerigmeyer avatar Feb 07 '24 17:02 jgerigmeyer

Will try to take a look tonight. Can you create the changelog as a draft release so I can take a look?

LeaVerou avatar Feb 07 '24 20:02 LeaVerou

Can you create the changelog as a draft release so I can take a look?

@LeaVerou Draft added (and organized a bit): https://github.com/color-js/color.js/releases/tag/untagged-7750f50c445118e5091c

jgerigmeyer avatar Feb 07 '24 22:02 jgerigmeyer

@LeaVerou All PRs are merged now -- should I go ahead with a release, and if so do you prefer beta or direct to v0.5.0?

jgerigmeyer avatar Feb 08 '24 15:02 jgerigmeyer

I think #408 should be dealt with before doing a release.

lloydk avatar Feb 09 '24 06:02 lloydk

I think #408 should be dealt with before doing a release.

Nevermind, turns out it wasn't an issue.

lloydk avatar Feb 09 '24 16:02 lloydk

Thank you so much @jgerigmeyer for getting this started. I made a pass and made several edits. Some high level feedback that may help for the future is:

  • We don't need to faithfully replicate PR titles, it's more important that the changelog reads like a list of changes
  • Wording should focus around the value proposition for users, not the low level implementation details

This still needs some work, so I suggest holding off for a bit more.

LeaVerou avatar Feb 09 '24 20:02 LeaVerou

Is it worth mentioning in the release notes that we didn't add dashed ident for rec2100-hlg, rec2100-pq, Jzazbz, JzCzHz and ICtCp because, while these are not in CSS Color 4, they are in the recently-adopted CSS Color HDR?

svgeesus avatar Feb 09 '24 21:02 svgeesus

Ugh, do not hit Cmd+Enter when editing a draft release! I just did that and accidentally published the release!! 🤦🏽‍♀️🤦🏽‍♀️🤦🏽‍♀️ I had to delete it and create a new draft, since there’s no way to return a release to draft mode 🤦🏽‍♀️ Did you get an email?

LeaVerou avatar Feb 09 '24 22:02 LeaVerou

Did you get an email?

I didn't get an email or notification, and I'm watching "All Activity" on this repo.

jgerigmeyer avatar Feb 09 '24 22:02 jgerigmeyer

Did you get an email?

I didn't get an email or notification, and I'm watching "All Activity" on this repo.

Interesting. I did.

LeaVerou avatar Feb 10 '24 08:02 LeaVerou

So, are we merging

  • https://github.com/color-js/color.js/pull/420

before release?

svgeesus avatar Feb 11 '24 16:02 svgeesus

HCT is now merged!

svgeesus avatar Feb 11 '24 18:02 svgeesus

So we are blocked on solving

  • https://github.com/color-js/color.js/issues/433

svgeesus avatar Feb 14 '24 04:02 svgeesus

So we are blocked on solving

See my comment: https://github.com/color-js/color.js/issues/433#issuecomment-1942996302

The PR doesn't allow for parsing both dashed and non-dashed id as suggested in the issue. If we want to support dashed and non-dashed ids then more work needs to be done.

lloydk avatar Feb 14 '24 05:02 lloydk

Thanks for working on this @lloydk! I left a comment in the PR, but if this issue is present in the previous release as well, then it's not a blocker.

LeaVerou avatar Feb 14 '24 15:02 LeaVerou

It would be good to get #439 (or a version of it) merged, but then I think this is ready for at least an alpha/beta release?

jgerigmeyer avatar Feb 15 '24 17:02 jgerigmeyer

I agree. If color.js is serializing a color to a specific format, it should be able to parse it as well. #439 (or some equivalent fix) seems important enough to wait for.

facelessuser avatar Feb 15 '24 17:02 facelessuser

So, https://github.com/color-js/color.js/pull/439 is merged.

svgeesus avatar Feb 29 '24 22:02 svgeesus

So, https://github.com/color-js/color.js/pull/439 is merged.

Draft release notes are updated, local testing today revealed https://github.com/color-js/color.js/pull/466 which I was hoping we could merge before release if @MysteryBlokHed or someone else could review.

jgerigmeyer avatar Feb 29 '24 22:02 jgerigmeyer

https://github.com/color-js/color.js/pull/466 is merged, I'll release v0.5.0 tonight unless someone else beats me to it or raises a blocking issue.

jgerigmeyer avatar Feb 29 '24 23:02 jgerigmeyer

Do we want to resolve #442 before doing a release?

lloydk avatar Feb 29 '24 23:02 lloydk

Do we want to resolve #442 before doing a release?

@lloydk I think #442 is a good addition, but I don't view it as a blocker for v0.5.0.

jgerigmeyer avatar Mar 01 '24 03:03 jgerigmeyer