Set up automated NPM package publishing workflow

[r-near]

Overview

Set up a comprehensive NPM package publishing workflow with versioning, changelogs, and automated releases.

Objectives

• Set up build system with tsup
• Implement changesets for version management and changelogs
• Configure GitHub Actions for automated testing and deployment
• Set up NPM package configuration and publishing workflow

Detailed Requirements

Build System (tsup)

• Install and configure tsup for TypeScript build
• Set up build configuration for multiple formats (ESM, CJS)
• Configure TypeScript declaration file generation
• Add build scripts to package.json
• Set up build caching for faster development

Changesets

• Install and initialize changesets
• Set up changeset configuration
• Create documentation for team on how to use changesets
• Configure changeset bot for PR management
• Set up automated changelog generation

Automated Publishing

• Create GitHub Actions workflow for:
  • Automated testing on PRs
  • Build verification
  • Changeset version updates
  • NPM package publishing
• Set up NPM authentication in GitHub Actions
• Configure release triggers
• Add status checks for required steps

Package Configuration

• Update package.json with:
  • Correct entry points (ESM/CJS)
  • Types field
  • Exports map
  • Package metadata
  • Repository info
• Set up .npmignore or files array
• Configure package access and scope
• Add README with installation and usage instructions

Additional Considerations

• Set up semantic release configuration
• Add release preview environment
• Configure dependabot for dependency updates
• Set up bundle size monitoring
• Add package publishing documentation
• Configure package tag management

Technical Notes

• Use tsup for its zero-config TypeScript build system and built-in optimizations
• Changesets will handle versioning and changelog generation automatically
• Consider using npm workspaces if we plan to split into multiple packages
• May want to consider adding bundle analysis tools

Resources

• tsup documentation
• Changesets documentation
• GitHub Actions for NPM
• NPM package publishing guide