javascript icon indicating copy to clipboard operation
javascript copied to clipboard

@clerk/upgrade package

Open jescalan opened this issue 1 year ago • 1 comments

Description

This is a new package that handles upgrading to new major versions of Clerk's SDKs. It is a CLI that guides the user through a set of configuration options, then scans their codebase for a list of regex patterns tied to description of breaking changes and their fixes, which it displays in the CLI output. The same descriptions are used to generate a changelog of breaking changes for each major version we release.

This package is not yet complete, for either the code and functionality or the directory of all breaking changes for the upcoming major version, but it's a good ways along so it felt like the right time to get the PR open so others could take a look, review, and leave feedback.

Checklist

  • [ ] npm test runs as expected.
  • [ ] npm run build runs as expected.
  • [ ] (If applicable) JSDoc comments have been added or updated for any package exports
  • [ ] (If applicable) Documentation has been updated

Type of change

  • [ ] 🐛 Bug fix
  • [x] 🌟 New feature
  • [ ] 🔨 Breaking change
  • [ ] 📖 Refactoring / dependency upgrade / documentation
  • [ ] other:

Packages affected

  • [ ] @clerk/backend
  • [ ] @clerk/chrome-extension
  • [ ] @clerk/clerk-js
  • [ ] @clerk/clerk-expo
  • [ ] @clerk/fastify
  • [ ] gatsby-plugin-clerk
  • [ ] @clerk/localizations
  • [ ] @clerk/nextjs
  • [ ] @clerk/clerk-react
  • [ ] @clerk/remix
  • [ ] @clerk/clerk-sdk-node
  • [ ] @clerk/shared
  • [ ] @clerk/themes
  • [ ] @clerk/types
  • [ ] build/tooling/chore

jescalan avatar Jan 03 '24 20:01 jescalan

🦋 Changeset detected

Latest commit: 02875ff9c4cddca885fbbeb70bc7b59bef7b5d4f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@clerk/upgrade Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

changeset-bot[bot] avatar Jan 03 '24 20:01 changeset-bot[bot]