mirror of https://github.com/tiennm99/goclaw.git synced 2026-09-17 08:21:18 +00:00

Files

T

viettranx 1dd5635f2b docs: document CI/CD pipelines, release flow, and v2.66.0 changelog

- CLAUDE.md: add CI/CD & Releases section with workflow table, tag
  patterns, Docker variants, beta/desktop release commands
- CONTRIBUTING.md: expand Releases section with standard (auto),
  beta (manual tag), and desktop release workflows
- docs/17-changelog.md: add v2.66.0 entry covering IDOR fix, BytePlus
  provider, per-agent grants, beta pipeline, and CI fixes

2026-04-05 11:22:30 +07:00

3.6 KiB

Raw Blame History

Contributing to GoClaw

Branch Strategy

main (stable, protected — owner-only merge)
  └── dev (default target for all PRs)
        ├── feat/xxx
        ├── fix/xxx
        └── ...

Rules

All PRs target dev — main is frozen for stable releases
Hotfixes — PR to main, then cherry-pick to dev
Releases — owner merges dev → main when stable
Direct push to main — blocked (ruleset enforced)

Branch Naming

feat/description — new features
fix/description — bug fixes
hotfix/description — urgent production fixes (target main)
refactor/description — code improvements
docs/description — documentation changes

PR Guidelines

Before Submitting

go fix ./...                        # Apply Go upgrades
go build ./...                      # PG build check
go build -tags sqliteonly ./...     # Desktop build check
go vet ./...                        # Static analysis
go test -race ./...                 # Tests with race detector

For web UI changes:

cd ui/web && pnpm build

PR Review Criteria

Based on our automated review checklist:

Correctness: No logic errors, nil dereference, race conditions
Security: Parameterized SQL, no hardcoded secrets, input validation
Breaking changes: API contracts, DB migrations, config format
Tenant isolation: All queries scoped by tenant_id
i18n: User-facing strings in all 3 locales (en/vi/zh)
SQLite parity: Changes compile with -tags sqliteonly
Mobile UI: h-dvh not h-screen, 16px input fonts, safe areas

Commit Messages

Use conventional commits:

feat: add user preferences API
fix: prevent race condition in session cleanup
docs: update API reference for v2 endpoints
refactor: extract provider retry logic

Workflow

Developer                    Reviewer                 Owner
    │                            │                      │
    ├─ create feat/xxx ──────────┤                      │
    ├─ PR → dev ─────────────────┤                      │
    │                            ├─ review + approve    │
    │                            ├─ CI passes ──────────┤
    │                            │                      ├─ merge to dev
    │                            │                      │
    │                            │        (when stable) ├─ PR dev → main
    │                            │                      ├─ merge → auto release
    │                            │                      │  (semantic-release)

Releases

Standard (automatic)

Merge dev → main. go-semantic-release analyzes commit messages and auto-creates:

GitHub Release with version tag (vX.Y.Z)
Cross-platform binaries (linux/darwin × amd64/arm64)
Docker images (4 variants: latest, base, full, otel + web)
SHA256 checksums
Discord notification

Beta (manual tag)

Push a beta tag from dev to create a prerelease:

# Standard beta — builds Docker + Linux binaries
git tag v2.67.0-beta.1
git push origin v2.67.0-beta.1

# Desktop beta — builds macOS .dmg + Windows .exe
git tag lite-v1.2.0-beta.1
git push origin lite-v1.2.0-beta.1

Beta releases are marked as prerelease on GitHub and use :beta rolling Docker tag.

Desktop / Lite

Push a lite-v* tag to build desktop apps:

git tag lite-v1.1.0
git push origin lite-v1.1.0

Tags with -beta or -rc suffix automatically create prereleases.

3.6 KiB Raw Blame History Unescape Escape