Release Process¶
This page documents how NetTap releases are versioned, built, and published.
Versioning Scheme¶
NetTap uses phase-based semantic versioning. Development versions increment with each phase milestone:
| Milestone | Version | Tag Location |
|---|---|---|
| Phase 1 complete (Core Infrastructure) | v0.1.0 |
main |
| Phase 2 complete (Storage Management) | v0.2.0 |
main |
| Phase 3 complete (Onboarding UX) | v0.3.0 |
main |
| Phase 4 complete (Dashboard Polish) | v0.4.0 |
main |
| Phase 5 complete (Community Release) | v1.0.0 |
main |
Patch Versions¶
Hotfixes within a phase use patch versions: v0.1.1, v0.1.2, etc.
Pre-Release Versions¶
Testing releases use pre-release suffixes:
v1.0.0-alpha.1--- early testing, features incompletev1.0.0-beta.1--- feature complete, bug fixingv1.0.0-rc.1--- release candidate, final testing
Branch Strategy¶
main ──●────●────●────●──── tag v0.4.0 ────●────●──── tag v1.0.0
\ / \ / \ /
feature/a fix/b feature/c
- NetTap is trunk-based:
mainis the only long-lived branch (nodevelopsince 2026-10-27) - All development happens on short-lived
feature/,fix/,chore/,docs/branches that squash-merge intomainvia PR - Phase tags are applied on
mainwhen all tasks for that phase are merged - Full rules:
.claude/rules/git-workflow.md
Release Steps¶
Tagging a Phase Milestone¶
When all tasks for a phase are complete and merged to main:
git checkout main
git pull origin main
# Create annotated tag
git tag -a v0.X.0 -m "Phase X: Description of milestone"
# Push the tag
git push origin v0.X.0
Creating a GitHub Release¶
- Go to Releases on GitHub
- Click "Draft a new release"
- Select the tag (e.g.,
v0.3.0) - Write release notes summarizing:
- New features
- Bug fixes
- Breaking changes (if any)
- Upgrade instructions
- Publish the release
Docker Image Publishing¶
Docker images are built and tagged for each release:
# Build images
docker compose -f docker/docker-compose.yml build
# Tag with version
docker tag nettap/storage-daemon:latest nettap/storage-daemon:v0.3.0
docker tag nettap/web:latest nettap/web:v0.3.0
# Push to registry (if applicable)
docker push nettap/storage-daemon:v0.3.0
docker push nettap/web:v0.3.0
Changelog Generation¶
NetTap uses git-cliff to generate changelogs from conventional commit messages:
# Generate changelog for all versions
git cliff -o CHANGELOG.md
# Generate changelog for a specific version range
git cliff v0.2.0..v0.3.0
# Preview changelog without writing
git cliff --unreleased
The conventional commit types map to changelog sections:
| Commit Type | Changelog Section |
|---|---|
feat |
Features |
fix |
Bug Fixes |
perf |
Performance |
docs |
Documentation |
refactor |
Refactoring |
test |
Testing |
chore, ci |
Miscellaneous |
CI/CD Pipeline¶
GitHub Actions automates the build and test pipeline:
On Every Push / PR¶
- Lint: ShellCheck, Ruff, ESLint
- Test: pytest, Vitest, svelte-check
- Build: Docker images compile successfully
On Tag Push¶
- All of the above
- Docker build and push to container registry
- GitHub Release draft creation
Dependency Pinning¶
Malcolm Stack¶
Malcolm container images are pinned to a tested release tag in docker-compose.yml:
This prevents upstream breaking changes. The tag is only updated after the new Malcolm release has been tested with NetTap.
Python Dependencies¶
Python dependencies are pinned in daemon/requirements.txt with specific versions.
Node.js Dependencies¶
Node.js dependencies are managed via web/package.json with a lockfile (package-lock.json) for reproducible builds.