payload-plugin-release

aniketpanjwani's avatarfrom aniketpanjwani

Automates the release workflow for the Payload Newsletter Plugin. Use when releasing a new version, bumping the version, or publishing to npm.

⭐32stars🔀2forks📁View on GitHub🕐Updated Dec 11, 2025

When & Why to Use This Skill

This Claude skill automates the end-to-end release workflow for the Payload Newsletter Plugin. It streamlines version management, changelog updates, and npm publishing by integrating with GitHub Actions, ensuring consistent, error-free software deployments and adherence to semantic versioning.

Use Cases

  • Automated Version Bumping: Seamlessly increment patch, minor, or major versions in package.json following semantic versioning rules.
  • Changelog Management: Automatically generate and format standardized changelog entries to maintain a transparent project history.
  • CI/CD Pipeline Integration: Trigger GitHub Actions for automated testing, building, and npm publishing by pushing commits to the main branch.
  • Pre-release Validation: Execute automated typechecks (e.g., via Bun) before committing changes to prevent broken code from reaching production.
namepayload-plugin-release
descriptionAutomates the release workflow for the Payload Newsletter Plugin. Use when releasing a new version, bumping the version, or publishing to npm.
Execute the automated release workflow for the Payload Newsletter Plugin, ensuring proper versioning, changelog updates, and triggering GitHub Actions for npm publishing. - NEVER create git tags manually - GitHub Actions handles tag creation - ALWAYS check the current date before updating changelog - ALWAYS run typecheck before committing release changes - Version bumps follow semantic versioning (major.minor.patch) What type of release?
  1. Patch (bug fixes) - e.g., 0.25.11 → 0.25.12
  2. Minor (new features, backward compatible) - e.g., 0.25.11 → 0.26.0
  3. Major (breaking changes) - e.g., 0.25.11 → 1.0.0

Also provide: What changes are being released? (for changelog)

Run typecheck to ensure no TypeScript errors: ```bash bun typecheck ``` If errors exist, fix them before proceeding. Check current version: ```bash grep '"version"' package.json | head -1 ``` Get current date for changelog: ```bash date +"%Y-%m-%d" ``` Update version in package.json based on release type: - Patch: increment last number (0.25.11 → 0.25.12) - Minor: increment middle, reset last (0.25.11 → 0.26.0) - Major: increment first, reset others (0.25.11 → 1.0.0) Add entry at TOP of CHANGELOG.md:
## [NEW_VERSION] - YYYY-MM-DD

### Fixed/Added/Changed
- Description of changes

Categories to use:

  • Added - new features
  • Changed - changes in existing functionality
  • Fixed - bug fixes
  • Removed - removed features
  • Security - security fixes
```bash git add package.json CHANGELOG.md git commit -m "chore: release vX.Y.Z" git push origin main ```

GitHub Actions will automatically:

  1. Detect the new version
  2. Run tests and type checking
  3. Build the project
  4. Create the git tag
  5. Publish to npm
  6. Create a GitHub release
Direct user to monitor the release: https://github.com/aniketpanjwani/payload-plugin-email-newsletter/actions - TypeScript passes with no errors - Version bumped correctly in package.json - CHANGELOG.md updated with correct date and version - Changes committed and pushed to main - User directed to GitHub Actions to monitor release