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.

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

v2.1.0 #143

Closed
wants to merge 1 commit into from
Closed

v2.1.0 #143

wants to merge 1 commit into from

Conversation

lgarron
Copy link
Member

@lgarron lgarron commented Jan 3, 2025

Release notes:

  • Overhaul the build system. The usage is still the same and icon sizing and layout should be compatible, but:
    • Fonts are no longer inlined into the CSS, allowing for loading of the most efficient format available.
    • Exports are now specifed by the package:
      • @cubing/icons/css: the new recommended entry point for CSS.
      • @cubing/icons/ts: data about available icons in TypeScript.

@lgarron lgarron requested a review from jfly January 3, 2025 11:40
package.json Outdated
@@ -29,7 +29,10 @@
"url": "https://github.com/cubing/icons.git/issues"
},
"description": "Cubing Icons and Fonts",
"files": ["dist", "ts"],
"files": [
Copy link
Member Author

Choose a reason for hiding this comment

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

@jfly: This is the fight between Biome and npm version I mentioned. I think Biome's formatting is better, but npm is the canonical tool for package publication. Not sure what the best option is here.

Copy link
Member

Choose a reason for hiding this comment

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

Gotcha. I'm happy with:

  1. Ignoring package.json
  2. OR: adding a postversion that formats package.json

Copy link
Member Author

Choose a reason for hiding this comment

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

Alright, I'll stick with ignoring.

postversion might be a good start, but there are various reasons tools might rewrite package.json and I don't have a full list anywhere.

@lgarron
Copy link
Member Author

lgarron commented Jan 3, 2025

Release plan:

git switch release-v2.1.0
git rebase main

git checkout main
git merge --ff-only release-v2.1.0

# Using: https://github.com/lgarron/dotfiles/blob/b71bea0c5d3a8c310f67145329f807eb2a8d417b/scripts/git/tagpush.ts
tagpush
make publish

lgarron added a commit that referenced this pull request Jan 3, 2025
This is a pre-release for #143 to test end-to-end ecosystem compatibility.
lgarron added a commit that referenced this pull request Jan 3, 2025
This is a pre-release for #143 to test end-to-end ecosystem compatibility.
lgarron added a commit that referenced this pull request Jan 3, 2025
This is a pre-release for #143 to test end-to-end ecosystem compatibility.
Release notes:

- Overhaul the build system. The usage is still the same and icon sizing and layout should be compatible, but:
  - Fonts are no longer inlined into the CSS, allowing for loading of the most efficient format available.
  - Exports are now specifed by the package:
    - `@cubing/icons/css`: the new recommended entry point for CSS.
    - `@cubing/icons/ts`: data about available icons in TypeScript.
@lgarron
Copy link
Member Author

lgarron commented Jan 3, 2025

Okay, I shook out a few things in the pre-releases and https://cdn.cubing.net/v0/css/@cubing/icons/css is now working well.

lgarron added a commit that referenced this pull request Jan 4, 2025
This is a pre-release for #143 to test end-to-end ecosystem compatibility.
@lgarron
Copy link
Member Author

lgarron commented Jan 9, 2025

@jfly, you good with releasing?

(There's a merge conflict, but it just needs a rebase once we know what version we're bumping from.)

@jfly
Copy link
Member

jfly commented Jan 9, 2025

Release plan: [...]

uber nit: Can we stick to the documented release process?

@lgarron
Copy link
Member Author

lgarron commented Jan 9, 2025

Release plan: [...]

uber nit: Can we stick to the documented release process?

Unfortunately, I actually really disagree with that process, as it:

  • Does not put the release notes into git history.
  • Does not put release notes into the GitHub release (by the corresponding workflow).
  • Diverges from the process used by all the other cubing/@cubing packages.

That said, I would definitely really like to have a re-think of this once we introduce npm publication from GitHub, whether that means something like conventional commits, in-tree release notes, or otherwise.

@lgarron
Copy link
Member Author

lgarron commented Jan 9, 2025

From talking to @jfly, I'm actually going to bump this to v3.0.0. The switch to fantasticon was not meant to be a breaking change, but:

  1. https://www.hyrumslaw.com/
  2. Obligatory XKCD:
    workflow_2x

A full version bump at least avoids anyone who's relying on semantic version to avoid implicit behaviour.

@lgarron
Copy link
Member Author

lgarron commented Jan 9, 2025

@jfly
Copy link
Member

jfly commented Jan 9, 2025

That said, I would definitely really like to have a re-think of this once we introduce npm publication from GitHub

Agreed. Let's discuss over in cubing/actions-workflows#3

@lgarron lgarron deleted the release-v2.1.0 branch January 22, 2025 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants