Skip to content
This repository was archived by the owner on Jun 24, 2023. It is now read-only.

Home

Jump to bottom
Dominik Ferber edited this page Jun 10, 2020 · 6 revisions

Welcome to the auth-email wiki!

This wiki is used for notes regarding development of @happykit/auth-email itself.

The documentation for how to use @happykit/auth-email is at docs.happykit.dev.

Releases

Releases are currently done manually.

At the top-level, run yarn test before you release.

  1. Check the version field in /auth-email/package.json.
  2. Globally search for that version and upgrade it to the new version
  3. Commit and Push to next
  4. At the top-level, run yarn build and then yarn pub
  5. You are prompted for the new version. Use whatever you committed to the code earlier.
  6. After releasing, merge the next branch to the master branch so the starters use the new version!
  7. Write release notes
  8. That's it

We hope to automate this process as the process matures.

Development

To set things up, you'll need to run yarn once at the top-level.

For daily development, open two terminals:

  • Run yarn dev in /auth-email: This will build the package itself
  • Run yarn dev in /starter-typescript: This will use the built package

Sometimes you'll need to restart yarn dev in /starter-typescript after making changes to the server-side of /auth-email.

As @happykit/auth-email comes with a CLI, you might want to try the CLI on a fresh project. You can use /pristine and /pristine-typescript for that. These two folders should always stay there as pristine create-next-app projects.

Clone this wiki locally