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

Update swc_core to v0.75.x #25

Merged
merged 1 commit into from
Apr 14, 2023
Merged

Update swc_core to v0.75.x #25

merged 1 commit into from
Apr 14, 2023

Conversation

kdy1
Copy link
Contributor

@kdy1 kdy1 commented Apr 14, 2023

There's no breaking change in crates related to mdxjs, but we updated wasmer to v3, so we marked it as a breaking change to prevent implicit regressions

@kwonoj
Copy link
Collaborator

kwonoj commented Apr 14, 2023

@wooorm for the visibility, this is pure swc_core update so we'll merge & publish new version. Please let us know anytime if there are something wrong.

@kwonoj kwonoj merged commit 833eacf into wooorm:main Apr 14, 2023
@kdy1 kdy1 deleted the swc-0-75 branch April 14, 2023 02:02
@wooorm
Copy link
Owner

wooorm commented Apr 14, 2023

Yeah, feel free to publish! Great!

I’d only ask that the commits/PRs/releases follow the existing project format.

Commit

A commit for this PR can look like:

Update `swc_core`

Closes GH-24.
  • Short descriptive message as title
  • No issue/PR references in title
  • Reference the issues/PRs that are closed in the commit body
  • Optionally you can include who reviewed or co-authored this if you want:
    Reviewed-by: Titus Wormer <tituswormer@gmail.com>
    
    Co-authored-by: Titus Wormer <tituswormer@gmail.com>
    

Release

I’m fine with you cutting a release locally, no need to do that in a PR. You probably cargo release it locally anyway.
Here’s what I do: https://github.com/wooorm/mdxjs-rs/blob/main/.github/contribute.md#release

Release notes

Here’s how I produce release notes:

  • Go to releases: https://github.com/wooorm/mdxjs-rs/releases
  • Click “Draft a new release”
  • Click “Choose a release”
  • Choose the one you just released
  • Click “Generate release notes”, in this case it would generate:
    ## What's Changed
    * Update `swc_core` by @kdy1 in https://github.com/wooorm/mdxjs-rs/pull/25
    
    **Full Changelog**: https://github.com/wooorm/mdxjs-rs/compare/0.1.10...0.1.11
  • Locally, I run git l, which is a git alias for l = log --pretty=oneline --graph --abbrev-commit. It produces a list of the commits. In this case, I’d get:
    * 4513866 (HEAD -> main, tag: 0.1.11, origin/main) 0.1.11
    * 833eacf Update `swc_core`
  • Now I manually merge those two results, to get:
    * 833eacf Update `swc_core`
      by @kdy1 in https://github.com/wooorm/mdxjs-rs/pull/25
    
    **Full Changelog**: https://github.com/wooorm/mdxjs-rs/compare/0.1.10...0.1.11
    
  • Finally, I try to think what a reader needs/want to see. What is breaking? What is actually important? These small updates don’t need anything. But if there are new features or lots of commits or breaking things, I reorder and amend stuff to highlight what’s important and what users need to do!

Let me know if you want me to write things down somewhere, e.g., contributing guides.
It’s just how I do things everywhere personally, so it’s not written down anywhere.

@kwonoj
Copy link
Collaborator

kwonoj commented Apr 14, 2023

@wooorm thanks, these are great.

If you can write these somewhere it'll be grrat, as there'll be someone other than me potentially need to release and all of us can reference it.

wooorm added a commit that referenced this pull request Apr 20, 2023
@wooorm
Copy link
Owner

wooorm commented Apr 20, 2023

Done, the parts from my previous comment are now also in contribute.md!

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.

3 participants