create-ezts-lib

{{package.name}}

PLEASE READ ME.

This starter template was generated from ts-package-kit and gives you a sane starting point for creating and publishing a TypeScript library.

Soon your releases will be automated, but we need to take a few manual steps first. Please follow along!

• Install dependencies with pnpm install.
• Manually cut our first release (subsequent releases will be automated with changesets)
  • Ensure you're logged in to NPM from the command line. If npm whoami doesn't return your expected username, login with npm login.
  • Run pnpm publish.
  • At this point, your 0.0.1 release should be visible on your NPM Packages listing page.
• Setting up GitHub repo
  • Create a GitHub repository with the same org/package name from the ezts-lib CLI prompts.
  • Locally, initialize the git repo: git init . && git add . && git commit -am "First commit".
  • Then push to your remote repo: git push -u origin main.
• Add NPM Granular Access Token
  • On NPM open the Access Tokens page.
  • Click Generate New Token > Granular Access Token and give your token a reasonable name, description, and expiration.
  • Then, give that token Read and Write access to the specific package you just published.
  • Submit the access token form, and make sure to copy the generated access token from the next page!
• Add NPM token to your GitHub Repository
  • From your GitHub repository settings, go to Secrets and variables > Actions and press New Repository Secret.
  • Name the new secret NPM_TOKEN (the name matters here!) and paste your granular access token into the Secret field. Then submit that form.
  • From your repo settings, go to Settings > Actions > General and check Allow GitHub Actions to create and approve pull requests, which is needed for changeset release automation.
• Take 'er for a spin!
  • Create a new branch and make a simple change.
  • Run pnpm run changeset and fill out the CLI prompts to add a new changeset record.
  • Make a pull request with this branch, and merge into main.
  • Wait a few minutes, and changeset should create a Version Packages PR.
  • Take a peak at that Version Packages PR, and approve/merge it once you're ready to cut your release.
  • At this point, you should have just released your next version with package provenance set up.

Where to go from here?

TODO: