Semantic Versioning

by aj-geddes3f5182cfd739No license355 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 7 months ago

Implement semantic versioning (SemVer) with automated release management. Use conventional commits, semantic-release, and version bumping strategies.

AI-generated overview

Sets up semantic versioning and automated release management using conventional commits and semantic-release.

What it does
This skill establishes semantic versioning practices for consistent MAJOR.MINOR.PATCH numbering tied to release significance. It covers conventional commit formatting, semantic-release configuration, version bumping strategies, changelog generation, and breaking-change tracking. It ships reference guides, a validation script, and an API scaffold template to support the setup.
When to use it
Use it when releasing packages or libraries, versioning APIs, automating version bumps, generating release notes or changelogs, or tracking breaking changes and dependencies.
Requirements
Requires Node.js tooling such as semantic-release and conventional-changelog-cli, plus a git repository; it ships executable scripts and reference documents.

Semantic Versioning

Table of Contents

Overview

Establish semantic versioning practices to maintain consistent version numbering aligned with release significance, enabling automated version management and release notes generation.

When to Use

  • Package and library releases
  • API versioning
  • Version bumping automation
  • Release note generation
  • Breaking change tracking
  • Dependency management
  • Changelog management

Quick Start

Minimal working example:

yaml
# package.json{  "name": "my-awesome-package",  "version": "1.2.3",  "description": "An awesome package",  "main": "dist/index.js",  "repository": { "type": "git", "url": "https://github.com/org/repo.git" },  "scripts": { "release": "semantic-release" },  "devDependencies":    {      "semantic-release": "^21.0.0",      "@semantic-release/changelog": "^6.0.0",      "@semantic-release/git": "^10.0.0",      "@semantic-release/github": "^9.0.0",      "conventional-changelog-cli": "^3.0.0",    },}

Reference Guides

Detailed implementations in the references/ directory:

GuideContents
Semantic Versioning Configuration [blocked]Semantic Versioning Configuration
Conventional Commits Format [blocked]Conventional Commits Format
Semantic Release Configuration [blocked]Semantic Release Configuration
Version Bumping Script [blocked]Version Bumping Script
Changelog Generation [blocked]Changelog Generation

Best Practices

✅ DO

  • Follow strict MAJOR.MINOR.PATCH format
  • Use conventional commits
  • Automate version bumping
  • Generate changelogs automatically
  • Tag releases in git
  • Document breaking changes
  • Use prerelease versions for testing

❌ DON'T

  • Manually bump versions inconsistently
  • Skip breaking change documentation
  • Use arbitrary version numbering
  • Mix features in patch releases

Source and attribution

Source:aj-geddes/useful-ai-promptsinskills/semantic-versioningat commit3f5182c

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal