docs: add mandatory release procedure to AGENTS.md
Document the correct order for creating releases: 1. Update pyproject.toml version 2. Update CHANGELOG.md 3. Commit version bump 4. Create tag 5. Push with --tags Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
@@ -184,18 +184,28 @@ cat ../webber-sandbox/TASKS.md
|
||||
## Versioning & Releases
|
||||
|
||||
Uses prefixed tags:
|
||||
- `api/v0.3.0` → Triggers API Docker build
|
||||
- `cli/v0.1.0` → Triggers CLI build (future)
|
||||
- `api/vX.Y.Z` → Triggers API Docker build
|
||||
- `cli/vX.Y.Z` → Triggers CLI build (future)
|
||||
|
||||
### MANDATORY Release Procedure
|
||||
|
||||
**NEVER push a tag before updating version files.** Follow this exact order:
|
||||
|
||||
```bash
|
||||
# API release
|
||||
cd webber-api
|
||||
# Update version in pyproject.toml
|
||||
git add -A && git commit -m "chore: release api v0.3.0"
|
||||
git tag api/v0.3.0
|
||||
# 1. Update version in pyproject.toml
|
||||
# 2. Update CHANGELOG.md with release notes
|
||||
# 3. Commit the version bump
|
||||
git add -A && git commit -m "chore: release api vX.Y.Z"
|
||||
|
||||
# 4. Create the tag (AFTER the commit)
|
||||
git tag api/vX.Y.Z
|
||||
|
||||
# 5. Push everything together
|
||||
git push origin main --tags
|
||||
```
|
||||
|
||||
**Why this matters:** Pushing a tag before the version commit requires deleting and recreating the tag, which can trigger CI/CD pipelines prematurely and cause deployment issues.
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Reference in New Issue
Block a user