-
Notifications
You must be signed in to change notification settings - Fork 0
Versioning Reference Guide
Garvin edited this page Nov 19, 2024
·
1 revision
Type | Commit Command | Effect | Example End Result |
---|---|---|---|
Major/Breaking | Add to commit message:+semver: breaking or +semver: major
|
Increments major version | 1.0.0 → 2.0.0 |
Minor/Feature | Add to commit message:+semver: feature or +semver: minor
|
Increments minor version | 1.0.0 → 1.1.0 |
Patch/Fix | Add to commit message:+semver: fix or +semver: patch
|
Increments patch version | 1.0.0 → 1.0.1 |
No Change | Add to commit message:+semver: none or +semver: skip
|
No version change | 1.0.0 → 1.0.0 |
# Breaking change
git commit -m "refactor!: completely new API
+semver: breaking"
# New feature
git commit -m "feat: add user authentication
+semver: feature"
# Bug fix
git commit -m "fix: correct calculation error
+semver: fix"
# No version change
git commit -m "docs: update README
+semver: none"
Branch Pattern | Mode | Default Increment | Source Branch | Special Behavior |
---|---|---|---|---|
master |
ContinuousDelivery | Patch | - | • Is release branch • Tracks merge target |
dev(elop)? |
ContinuousDeployment | Minor | master |
• Tracks release branches • Tracks merge target |
features?[/-] |
ContinuousDeployment | Inherit | develop |
• Inherits increment from parent |
hotfix(es)?[/-] |
ContinuousDeployment | Patch | master |
• Is release branch • Tracks merge target • Tracks release branches |
releases?[/-] |
ContinuousDeployment | None | develop |
• Is release branch • No automatic increments |
Setting | Value | Description |
---|---|---|
Tag Prefix | [vV] |
Tags must start with 'v' or 'V' |
Message Incrementing | Enabled | Commit messages can trigger version bumps |
Prevent Branch Increment | False | Branch merges can trigger increments |
Assembly Versioning | MajorMinorPatch | Uses standard semantic versioning |
Major.Minor.Patch
│ │ └── Bug fixes and patches
│ └──────── New features (non-breaking)
└────────────── Breaking changes