Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Release Quick Reference

Quick reference for the Tenki Cloud release system.

Commands

# Create new changelog (interactive with fzf if available)
changelog add

# Create empty changelog for internal changes
changelog add --empty

# Check status
changelog status

# Show help
changelog help

Changelog Format

---
"@tenki/app": minor
"@tenki/engine": patch
---

Brief description of changes

- Detailed change 1
- Detailed change 2

Components

ComponentTypeDeploymentOutput
@tenki/appNode.jsDockerapp:vX.Y.Z
@tenki/sentinelNode.jsDockersentinel:vX.Y.Z
@tenki/engineGoDockerengine:vX.Y.Z
@tenki/github-proxyGoDockergithub-proxy:vX.Y.Z
@tenki/cliGoBinarytenki-cli-vX.Y.Z-{os}-{arch}
@tenki/node-agentGoBinarynode-agent-vX.Y.Z-{os}-{arch}
@tenki/vm-agentGoBinaryvm-agent-vX.Y.Z-{os}-{arch}

Version Bump Types

TypeVersion ChangeUse Case
patch1.0.0 → 1.0.1Bug fixes, small improvements
minor1.0.0 → 1.1.0New features, backwards compatible
major1.0.0 → 2.0.0Breaking changes

Workflow

  1. Create changelogchangelog add
  2. Commit & pushgit add .releases/*.md && git commit && git push
  3. Review Release PR → Automatically created
  4. Merge Release PR → Triggers release automation
  5. Artifacts built → Docker images + binaries published

File Locations

.releases/
├── config.json                           # Configuration
└── your-feature.md                       # Temporary changelog

apps/app/CHANGELOG.md                      # App changelog
apps/sentinel/CHANGELOG.md                # Sentinel changelog
backend/cmd/engine/CHANGELOG.md           # Engine changelog
backend/cmd/tenki-cli/CHANGELOG.md        # CLI changelog
backend/cmd/node-agent/CHANGELOG.md       # Node agent changelog
backend/cmd/github-proxy/CHANGELOG.md     # GitHub proxy changelog
backend/cmd/vm-agent/CHANGELOG.md         # VM agent changelog

Common Patterns

Bug Fix

---
"@tenki/app": patch
---

Fix login redirect issue

New Feature

---
"@tenki/app": minor
"@tenki/engine": minor
---

Add workspace management

Breaking Change

---
"@tenki/cli": major
---

Restructure CLI commands

Multi-Component

---
"@tenki/app": minor
"@tenki/engine": patch
"@tenki/cli": patch
---

Improve runner monitoring

Troubleshooting

IssueSolution
Release PR not createdCheck changelog format and GitHub Actions logs
Build failureEnsure tests pass and Docker configs are correct
Wrong version calculatedReview frontmatter and component dependencies
CLI not workingRun direnv reload to pick up new scripts

Go Binary Versioning

  • All Go binaries share the same version from backend/go.mod
  • Highest bump type among Go components is used for all
  • Example: cli: patch + engine: minor = all Go binaries get minor