agent-ecosystem/docs/RELEASE.md
iliya f0c2677c6a feat: auto-publish releases with stable download links
- Change releaseType from draft to release for auto-publishing
- Add upload-stable-links job to create version-agnostic asset copies
- Update README with direct download URLs per platform
- Add Requirements section to Installation
- Remove downloads/platform badges
- Add docs/RELEASE.md with versioning and release guide
- Move community docs to .github/
2026-02-27 14:09:02 +02:00

6.4 KiB

Release Guide

Versioning (SemVer)

Format: MAJOR.MINOR.PATCH

Bump When Example
MAJOR Breaking changes, major UI overhaul, incompatible data format changes 1.0.0 → 2.0.0
MINOR New features, new panels/views, new integrations 1.0.0 → 1.1.0
PATCH Bug fixes, performance improvements, small UI tweaks 1.0.0 → 1.0.1

Release Process

1. Prepare

# Make sure branch is clean and pushed
git status
git push origin <branch>

2. Create tag and push

git tag v<VERSION>
git push origin v<VERSION>

This triggers the release.yml GitHub Actions workflow which:

  • Builds the app (ubuntu)
  • Packages macOS arm64 + x64 (with code signing & notarization)
  • Packages Windows (NSIS installer)
  • Packages Linux (AppImage, deb, rpm, pacman)
  • Creates a GitHub Release with all artifacts

3. Update release notes

After the workflow completes, edit the release notes:

gh release edit v<VERSION> --repo 777genius/claude_agent_teams_ui --notes "$(cat <<'EOF'
<paste release notes here>
EOF
)"

Release Notes Template

## Claude Agent Teams UI v<VERSION>

<1-2 sentence summary of the release>

### What's New
- feat: <feature description>
- feat: <feature description>

### Improvements
- improve: <improvement description>

### Bug Fixes
- fix: <bug fix description>

### Downloads

| Platform | File |
|----------|------|
| macOS (Apple Silicon) | [Claude-Agent-Teams-UI-<VERSION>-arm64.dmg](https://github.com/777genius/claude_agent_teams_ui/releases/download/v<VERSION>/Claude-Agent-Teams-UI-<VERSION>-arm64.dmg) |
| macOS (Intel) | [Claude-Agent-Teams-UI-<VERSION>.dmg](https://github.com/777genius/claude_agent_teams_ui/releases/download/v<VERSION>/Claude-Agent-Teams-UI-<VERSION>.dmg) |
| Windows | [Claude-Agent-Teams-UI-Setup-<VERSION>.exe](https://github.com/777genius/claude_agent_teams_ui/releases/download/v<VERSION>/Claude-Agent-Teams-UI-Setup-<VERSION>.exe) |
| Linux (AppImage) | [Claude-Agent-Teams-UI-<VERSION>.AppImage](https://github.com/777genius/claude_agent_teams_ui/releases/download/v<VERSION>/Claude-Agent-Teams-UI-<VERSION>.AppImage) |
| Linux (deb) | [claude-agent-teams-ui_<VERSION>_amd64.deb](https://github.com/777genius/claude_agent_teams_ui/releases/download/v<VERSION>/claude-agent-teams-ui_<VERSION>_amd64.deb) |
| Linux (rpm) | [claude-agent-teams-ui-<VERSION>.x86_64.rpm](https://github.com/777genius/claude_agent_teams_ui/releases/download/v<VERSION>/claude-agent-teams-ui-<VERSION>.x86_64.rpm) |
| Linux (pacman) | [claude-agent-teams-ui-<VERSION>.pacman](https://github.com/777genius/claude_agent_teams_ui/releases/download/v<VERSION>/claude-agent-teams-ui-<VERSION>.pacman) |

Changelog Guidelines

Write changelog entries from the user's perspective, not the developer's.

Good:

  • "Add team member activity timeline with live status tracking"
  • "Fix crash when opening sessions with corrupted JSONL data"
  • "Improve session list loading speed by 3x with streaming parser"

Bad:

  • "Refactor ChunkBuilder to use new pipeline"
  • "Update dependencies"
  • "Fix bug in useEffect cleanup"

Group entries by type: What's New > Improvements > Bug Fixes > Breaking Changes (if any).

File Naming Convention

electron-builder generates these artifacts per platform:

Platform Versioned Name Stable Name (for /latest/download)
macOS arm64 DMG Claude-Agent-Teams-UI-<VER>-arm64.dmg Claude-Agent-Teams-UI-arm64.dmg
macOS x64 DMG Claude-Agent-Teams-UI-<VER>.dmg Claude-Agent-Teams-UI-x64.dmg
macOS arm64 ZIP Claude-Agent-Teams-UI-<VER>-arm64-mac.zip
macOS x64 ZIP Claude-Agent-Teams-UI-<VER>-mac.zip
Windows Claude-Agent-Teams-UI-Setup-<VER>.exe Claude-Agent-Teams-UI-Setup.exe
Linux AppImage Claude-Agent-Teams-UI-<VER>.AppImage Claude-Agent-Teams-UI.AppImage
Linux deb claude-agent-teams-ui_<VER>_amd64.deb Claude-Agent-Teams-UI-amd64.deb
Linux rpm claude-agent-teams-ui-<VER>.x86_64.rpm Claude-Agent-Teams-UI-x86_64.rpm
Linux pacman claude-agent-teams-ui-<VER>.pacman Claude-Agent-Teams-UI.pacman

The upload-stable-links job in release.yml re-uploads key assets with version-agnostic names. This enables permanent links in README that always point to the latest release:

https://github.com/777genius/claude_agent_teams_ui/releases/latest/download/Claude-Agent-Teams-UI-arm64.dmg

GitHub automatically redirects /releases/latest/download/FILENAME to the asset from the most recent release. No README updates needed when releasing a new version.

macOS Code Signing

macOS builds are signed and notarized via GitHub Actions secrets:

Secret Description
CSC_LINK Base64-encoded .p12 certificate
CSC_KEY_PASSWORD Certificate password
APPLE_ID Apple Developer account email
APPLE_APP_SPECIFIC_PASSWORD App-specific password from appleid.apple.com
APPLE_TEAM_ID Apple Developer Team ID

Without these secrets, macOS builds will be unsigned (users need to bypass Gatekeeper manually).

Auto-Update

electron-builder generates latest-mac.yml, latest.yml, latest-linux.yml alongside release artifacts. These files enable the built-in auto-updater — users get notified when a new version is available.

Quick Reference

# Create and publish a release
git tag v1.1.0
git push origin v1.1.0
# Wait for CI to finish (~10 min), then update notes

# Delete a release (if needed)
gh release delete v1.1.0 --repo 777genius/claude_agent_teams_ui --yes
git tag -d v1.1.0
git push origin :refs/tags/v1.1.0

# Check workflow status
gh run list --repo 777genius/claude_agent_teams_ui --workflow release.yml --limit 3