From 54a27b481adef832acd05c53b103739ae3a63513 Mon Sep 17 00:00:00 2001 From: Jeroen Schweitzer Date: Tue, 16 Dec 2025 09:33:52 +0100 Subject: [PATCH] docs: add release flow section to AGENTS.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Documents the version bump, changelog update, tagging, and deployment verification steps. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 --- AGENTS.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 7d077be..1bda991 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -51,6 +51,32 @@ This document contains instructions and documentation references for AI assistan * **Update `CHANGELOG.md`** with every user-facing change. * Format: `## [Unreleased] - YYYY-MM-DD` followed by `### Added`, `### Changed`, or `### Fixed`. +### 🚀 Release Flow +When changes are ready for deployment: + +1. **Ask user if deploy cycle is desired ** + +2. **Update version** in `pyproject.toml`: + - Bug fixes: bump patch version (1.8.3 → 1.8.4) + - New features: bump minor version (1.8.4 → 1.9.0) + +3. **Update CHANGELOG.md**: + - Move items from `[Unreleased]` to new version section + - Add release date: `## [1.8.4] - 2025-12-16` + +4. **Commit and tag**: + ```bash + git add -A + git commit -m "fix: description of changes" + git tag v1.8.4 + git push origin main --tags + ``` + +5. **CI/CD triggers automatically**: + - Gitea CI builds Docker image on new tag + - Watchtower pulls and deploys to production + - Verify deployment: `curl http://192.168.86.149:8000/health` + --- ## 2. FastAPI Architecture & Best Practices