Skip to content

A GitHub Action that creates new releases using Semantic Versioning (SemVer).

License

Notifications You must be signed in to change notification settings

mirceanton/action-semver-release

Repository files navigation

Semantic Release Action

Automatically determine the next semantic version and generate release notes based on Conventional Commits.

Features

  • 🔍 Analyzes commits since the last GitHub release
  • 📊 Determines next version using semantic versioning rules
  • 📝 Generates release notes categorized by commit type
  • 🎯 Conventional Commits support with breaking change detection
  • 📋 Job Summary with visual version comparison table
  • Zero configuration - works out of the box

Example Usage

name: Release
on:
  push:
    branches: [main]

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          fetch-depth: 0

      - name: Generate Release Metadata
        id: release-metadata
        uses: mirceanton/action-semver-release@v2
        with:
          github-token: ${{ github.token }}

Inputs

Input Description Required Default
github-token GitHub token for API access Yes ${{ github.token }}
default-version Default version when no releases exist No 0.0.0
dry-run Run in dry-run mode (no actual release) No false
draft Mark the release as a draft No false
prerelease Mark the release as a pre-release No false

Outputs

Output Description Example
next-version The next semantic version 1.2.0
should-release Whether a new release should be created true
release-notes Generated release notes in markdown See example

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

A GitHub Action that creates new releases using Semantic Versioning (SemVer).

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

 

Contributors 4

  •  
  •  
  •  
  •