Skip to content

feat: reorder version scheme to RELEASE.BETA.ALPHA.BUILD with full automation #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tech-stack-studios merged 1 commit into from
May 27, 2026
Merged

feat: reorder version scheme to RELEASE.BETA.ALPHA.BUILD with full automation #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions .github/agents/branch-manager.agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,25 +29,25 @@ hotfix/* ───────────────────────

**Releases are git tags** (`release/x.y.z`), not branches. They are created automatically by CI when code merges into `main`. Never create a `release/` branch manually.

### Version Format: `MAJOR.ALPHA.BETA.BUILD`
### Version Format: `RELEASE.BETA.ALPHA.BUILD`

| Digit | Bumped by | Example |
|-------|-----------|---------|
| MAJOR | Manual | `2.0.0.0` |
| ALPHA | Merge to `alpha` | `1.3.0.0` |
| BETA | Merge to `beta` | `1.3.2.0` |
| BUILD | Merge to `develop` | `1.3.2.47` |
| Digit | Bumped by | Resets | Example |
|-------|-----------|--------|---------|
| RELEASE | Merge to `main` (automated) | BETA=0, ALPHA=0, BUILD=0 | `1.0.0.0` |
| BETA | Merge to `beta` | ALPHA=0, BUILD=0 | `0.1.0.0` |
| ALPHA | Merge to `alpha` | BUILD=0 | `0.0.2.0` |
| BUILD | Merge to `develop` | — | `0.0.1.47` |

### CI/CD per Branch

| Branch | Tests | Docker Image Tag | Version Bump |
|--------|-------|-----------------|--------------|
| `feature/*` | Unit tests | — | — |
| `develop` | Unit + e2e | `dev-{build}` | BUILD digit |
| `alpha` | All tests | `alpha-1.x.0.0` | ALPHA digit |
| `beta` | All + perf/load | `beta-1.0.x.0` | BETA digit |
| `uat` | Smoke tests (vs anonymised prod data) | Same as prod image | — |
| `main` | — | `1.2.3.4` (prod) | Creates `release/x.y.z` tag |
| Branch | Tests | Version Bump |
|--------|-------|--------------|
| `feature/*` | Unit tests | — |
| `develop` | Unit + build | BUILD digit |
| `alpha` | Unit + build | ALPHA digit, BUILD→0 |
| `beta` | Unit + build | BETA digit, ALPHA→0, BUILD→0 |
| `uat` | Smoke tests | none |
| `main` | Unit + build | RELEASE digit, all others→0; tags `release/X.0.0.0` |

### Naming Rules

Expand Down
38 changes: 27 additions & 11 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,20 +45,21 @@ jobs:
node-version: '24'
cache: 'npm'

# ── Version bump (push events only, not PRs, not main/uat) ────────────────
# Display version format: MAJOR.ALPHA.BETA.BUILD (stored in build.extraMetadata.version)
# Semver format: MAJOR.ALPHA.BETA (stored in version — required by electron-builder)
# ── Version bump (push events only, not PRs, not uat) ─────────────────────
# Display version format: RELEASE.BETA.ALPHA.BUILD (stored in build.extraMetadata.version)
# Semver format: RELEASE.BETA.ALPHA (stored in version — required by electron-builder)
#
# develop → increment BUILD (4th digit of extraMetadata.version only)
# alpha → increment ALPHA (2nd digit), reset BUILD to 0, sync 3-part version
# beta → increment BETA (3rd digit), reset BUILD to 0, sync 3-part version
# develop → increment BUILD (4th digit only)
# alpha → increment ALPHA (3rd digit), reset BUILD to 0
# beta → increment BETA (2nd digit), reset ALPHA and BUILD to 0
# main → increment RELEASE (1st digit), reset BETA/ALPHA/BUILD to 0, tag release/X.0.0.0
- name: Bump version
id: bump
if: github.event_name == 'push' && github.ref_name != 'main' && github.ref_name != 'uat'
if: github.event_name == 'push' && github.ref_name != 'uat'
run: |
# Read the 4-part display version from extraMetadata
EXT_VERSION=$(node -p "require('./package.json').build.extraMetadata.version")
IFS='.' read -r MAJOR ALPHA BETA BUILD <<< "$EXT_VERSION"
IFS='.' read -r RELEASE BETA ALPHA BUILD <<< "$EXT_VERSION"

case "${{ github.ref_name }}" in
develop)
Expand All @@ -70,13 +71,20 @@ jobs:
;;
beta)
BETA=$((BETA + 1))
ALPHA=0
BUILD=0
;;
main)
RELEASE=$((RELEASE + 1))
BETA=0
ALPHA=0
BUILD=0
;;
esac

NEW_EXT_VERSION="${MAJOR}.${ALPHA}.${BETA}.${BUILD}"
NEW_EXT_VERSION="${RELEASE}.${BETA}.${ALPHA}.${BUILD}"
# 3-part semver for electron-builder (strips the BUILD digit)
NEW_VERSION="${MAJOR}.${ALPHA}.${BETA}"
NEW_VERSION="${RELEASE}.${BETA}.${ALPHA}"

node -e "
const fs = require('fs');
Expand All @@ -97,7 +105,7 @@ jobs:
# Push the version bump commit AFTER tests pass so a failed test doesn't
# advance the version counter.
- name: Commit and push version bump
if: github.event_name == 'push' && github.ref_name != 'main' && github.ref_name != 'uat' && steps.bump.outputs.new-version != ''
if: github.event_name == 'push' && github.ref_name != 'uat' && steps.bump.outputs.new-version != ''
run: |
NEW_VERSION="${{ steps.bump.outputs.new-version }}"
git config user.name "github-actions[bot]"
Expand All @@ -107,6 +115,14 @@ jobs:
git diff --cached --quiet || git commit -m "chore: bump version to ${NEW_VERSION} [skip ci]"
git push

# On main: create a release tag after the version bump commit is pushed.
- name: Tag release
if: github.event_name == 'push' && github.ref_name == 'main' && steps.bump.outputs.new-version != ''
run: |
TAG="release/${{ steps.bump.outputs.new-version }}"
git tag "$TAG"
git push origin "$TAG"

# ─── Job 2: Build the .deb installer (only runs when all tests pass) ──────────
build:
name: Build Linux DEB
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"email": "fritz.blignaut@gmail.com"
},
"private": true,
"version": "1.0.0",
"version": "0.0.1",
"type": "module",
"main": "electron/main.cjs",
"scripts": {
Expand All @@ -26,7 +26,7 @@
"appId": "com.techstack.streamdeck",
"productName": "Tech Stack Stream Deck",
"extraMetadata": {
"version": "1.0.0.3"
"version": "0.0.1.0"
},
"directories": {
"output": "dist-electron"
Expand Down