Auto Release Template

Template for automated releases with semantic versioning & GitHub Actions.

Prepare a release locally, review it, and the workflow will automatically create a GitHub Release when a tag is pushed.

How It Works

1. Commit your changes following the Conventional Commits.
2. Run npm run release, which bumps the version, updates CHANGELOG.md, creates a commit, and adds a Git tag.
3. Push the changes using git push --follow-tags.
4. The GitHub Action detects the new tag and publishes a GitHub Release with the generated 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 Permissions

Repository → Settings → Actions → Workflow permissions → set to Read and write permissions.

⚠️ Releases will fail if this is not enabled.

Customization

To customize commit message formatting, tag prefix, or which commits appear in the changelog, edit the .versionrc file.

For the full list of supported options, check the Conventional Changelog Config Spec.

Advanced

More use cases and workflow examples are documented in the wiki:

• Automated NPM publishing with npm
• Automated NPM publishing with pnpm
• Draft Releases
• Provenance statements