| name | release-workflow |
| description | Use when preparing or executing a release of peek-stash-browser. Covers the full release lifecycle from validation through Docker image publishing. |
Release Workflow
Overview
Releases are triggered by pushing git tags. GitHub Actions builds and publishes Docker images automatically.
Pre-release validation → Version bump → Commit → Tag → Push → GitHub Actions → Docker Hub
Version Scheme
- Stable:
X.Y.Z (e.g., 3.3.1)
- Beta:
X.Y.Z-beta.N (e.g., 3.3.2-beta.1)
- Tag format:
vX.Y.Z or vX.Y.Z-beta.N
Both client/package.json and server/package.json must always have identical versions.
Step 1: Pre-Release Validation
Run /pre-release to execute all checks:
- Server unit tests:
cd server && npm test
- Server linting:
cd server && npm run lint
- Client unit tests:
cd client && npm test
- Client linting:
cd client && npm run lint
- Integration tests:
cd server && npm run test:integration
- Client build:
cd client && npm run build
- Docker production build:
docker build -f Dockerfile.production -t peek:test .
All 7 checks must pass before proceeding.
Step 2: Version Bump & Tag
Beta Release
Run /release-beta:
- Increment beta number:
3.3.2-beta.1 → 3.3.2-beta.2
- Or start new beta:
3.3.1 → 3.3.2-beta.1
Stable Release
Run /release-stable:
- Remove beta suffix:
3.3.2-beta.8 → 3.3.2
- Or increment:
3.3.2 → 3.3.3 or 3.4.0
What the Release Skills Do
- Verify on
main branch and up to date
- Update version in
client/package.json and server/package.json
- Commit:
chore: bump version to X.Y.Z
- Push commit to main
- Create tag:
git tag vX.Y.Z
- Push tag:
git push origin vX.Y.Z
Step 3: Automated CI/CD
GitHub Actions (.github/workflows/docker-build.yml) triggers on v* tags:
- Build: Multi-stage Dockerfile.production (frontend → backend → runtime)
- Platforms:
linux/amd64 + linux/arm64
- Push to Docker Hub:
carrotwaxr/peek-stash-browser
- Tag strategy:
- Semver:
3.3.2
- Major.minor:
3.3
latest (stable releases only)stable (stable releases only)beta (beta releases only)
- GitHub Release: Auto-created with generated release notes, marked as prerelease if beta
Docker Hub Tags After Release
| Release Type | Tags Applied |
|---|
v3.3.2 (stable) | 3.3.2, 3.3, latest, stable |
v3.3.2-beta.1 | 3.3.2-beta.1, beta |
Updating on unRAID
After GitHub Actions completes:
ssh root@<server-ip>
docker pull carrotwaxr/peek-stash-browser:latest
docker stop peek-stash-browser && docker start peek-stash-browser
Semantic Versioning Guide
- Patch (3.3.X): Bug fixes, minor tweaks, no new features
- Minor (3.X.0): New features, backward-compatible changes
- Major (X.0.0): Breaking changes (rare — major UI overhauls, API changes)
