Skip to content

Latest commit

 

History

History
22 lines (20 loc) · 1018 Bytes

README.md

File metadata and controls

22 lines (20 loc) · 1018 Bytes
Raw

NPM package template

  • 📝 Fully typed
  • 🚀 TS bundled using tsup
  • ✅ Strict type checking with tsc (no-emit)
  • 🛠️ Easy CI/CD with github actions
  • 📦 Automatic deployment to npm
  • 🏷️ Easy versioning with changeset
  • ⚡ Performance gains thanks to pnpm
  • 🌟 Inspired by @mattpocock and his example repo

Requirements

Usage

  1. Add a repository secret named NPM_TOKEN and set it to your npm access token
  2. Check the Allow GitHub Actions to create and approve pull requests box in repository settings, actions/general category
  3. Make some changes
  4. Run pnpm changeset and describe your changes
  5. Commit and push your changes
  6. Approve the pull request github actions made
  7. If actions succeed, check npm for published package