Auto Release Template

Template for automated releases with semantic versioning & GitHub Actions.

Prepare release locally, review, then publish automatically on tag push.

How It Works

1. Commit changes following Conventional Commits.
2. Run npm run release. This bumps the version, updates CHANGELOG.md, creates a commit and a Git tag.
3. Push changes git push --follow-tags.
4. GitHub Action will automatically create and publish a GitHub Release with the changelog.

Components

• absolute-version/commit-and-tag-version – bumps version, updates CHANGELOG.md, creates a commit and a Git tag.
• yashanand1910/standard-release-notes – generates release notes.
• softprops/action-gh-release – creates and publishes GitHub Releases.

Setup

GitHub Actions

⚠️ Important: GitHub Actions must have Read and write permissions enabled, otherwise the workflow will fail.

• Enable GitHub Actions.
• Go to repository settings → Actions → Workflow permissions, set to Read and write permissions.
• Ensure developers have push access for tags.

Customization

To customize releases (commit message format, tag prefix, or which commits appear in the changelog), edit the .versionrc file. Full configuration options are in the Conventional Changelog Config Spec.