chore: bump version to 2026.01.002 and document version policy
Some checks failed
Basil CI/CD Pipeline / Code Linting (push) Successful in 1m12s
Basil CI/CD Pipeline / Shared Package Tests (push) Successful in 1m28s
Basil CI/CD Pipeline / API Tests (push) Successful in 2m1s
Basil CI/CD Pipeline / Web Tests (push) Successful in 1m40s
Basil CI/CD Pipeline / Security Scanning (push) Successful in 1m22s
Basil CI/CD Pipeline / Build All Packages (push) Successful in 1m29s
Basil CI/CD Pipeline / E2E Tests (push) Has been skipped
Basil CI/CD Pipeline / Trigger Deployment (push) Has been cancelled
Basil CI/CD Pipeline / Build & Push Docker Images (push) Has been cancelled
Some checks failed
Basil CI/CD Pipeline / Code Linting (push) Successful in 1m12s
Basil CI/CD Pipeline / Shared Package Tests (push) Successful in 1m28s
Basil CI/CD Pipeline / API Tests (push) Successful in 2m1s
Basil CI/CD Pipeline / Web Tests (push) Successful in 1m40s
Basil CI/CD Pipeline / Security Scanning (push) Successful in 1m22s
Basil CI/CD Pipeline / Build All Packages (push) Successful in 1m29s
Basil CI/CD Pipeline / E2E Tests (push) Has been skipped
Basil CI/CD Pipeline / Trigger Deployment (push) Has been cancelled
Basil CI/CD Pipeline / Build & Push Docker Images (push) Has been cancelled
- Update version format to YYYY.MM.PPP (zero-padded) - Current version: 2026.01.002 - Document version management policy in CLAUDE.md - Version increments with every production deployment - Patch resets to 001 when month changes
This commit is contained in:
54
CLAUDE.md
54
CLAUDE.md
@@ -270,3 +270,57 @@ Basil includes a complete CI/CD pipeline with Gitea Actions for automated testin
|
||||
- `DOCKER_USERNAME` - Docker Hub username
|
||||
- `DOCKER_PASSWORD` - Docker Hub access token
|
||||
- `DEPLOY_WEBHOOK_URL` - Webhook endpoint for deployments
|
||||
|
||||
## Version Management
|
||||
|
||||
**IMPORTANT**: Increment the version with **every production deployment**.
|
||||
|
||||
### Version Format
|
||||
Basil uses calendar versioning with the format: `YYYY.MM.PPP`
|
||||
- `YYYY` - Four-digit year (e.g., 2026)
|
||||
- `MM` - Two-digit month with zero-padding (e.g., 01 for January, 12 for December)
|
||||
- `PPP` - Three-digit patch number with zero-padding that increases with each deployment in a month
|
||||
|
||||
### Examples
|
||||
- `2026.01.001` - First deployment in January 2026
|
||||
- `2026.01.002` - Second deployment in January 2026
|
||||
- `2026.02.001` - First deployment in February 2026 (patch resets to 001)
|
||||
- `2026.02.003` - Third deployment in February 2026
|
||||
|
||||
### Version Update Process
|
||||
When deploying to production:
|
||||
|
||||
1. **Update version files:**
|
||||
```bash
|
||||
# Update both version files with new version
|
||||
# packages/api/src/version.ts
|
||||
# packages/web/src/version.ts
|
||||
export const APP_VERSION = '2026.01.002';
|
||||
```
|
||||
|
||||
2. **Commit the version bump:**
|
||||
```bash
|
||||
git add packages/api/src/version.ts packages/web/src/version.ts
|
||||
git commit -m "chore: bump version to 2026.01.002"
|
||||
git push origin main
|
||||
```
|
||||
|
||||
3. **Create Git tag and release:**
|
||||
```bash
|
||||
# Tag should match version with 'v' prefix
|
||||
git tag v2026.01.002
|
||||
git push origin v2026.01.002
|
||||
|
||||
# Or use Gitea MCP to create tag and release
|
||||
```
|
||||
|
||||
4. **Document in release notes:**
|
||||
- Summarize changes since last version
|
||||
- List bug fixes, features, and breaking changes
|
||||
- Reference related pull requests or issues
|
||||
|
||||
### Version Display
|
||||
The current version is displayed in:
|
||||
- API: `GET /api/version` endpoint returns `{ version: '2026.01.002' }`
|
||||
- Web: Footer or about section shows current version
|
||||
- Both packages export `APP_VERSION` constant for internal use
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
/**
|
||||
* Application version following the pattern: YYYY.MM.PATCH
|
||||
* Example: 2026.01.1 (January 2026, patch 1)
|
||||
* Application version following the pattern: YYYY.MM.PPP
|
||||
* Example: 2026.01.002 (January 2026, patch 2), 2026.02.003 (February 2026, patch 3)
|
||||
* Month and patch are zero-padded. Patch increments with each deployment in a month.
|
||||
*/
|
||||
export const APP_VERSION = '2026.01.1';
|
||||
export const APP_VERSION = '2026.01.002';
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
/**
|
||||
* Application version following the pattern: YYYY.MM.PATCH
|
||||
* Example: 2026.01.1 (January 2026, patch 1)
|
||||
* Application version following the pattern: YYYY.MM.PPP
|
||||
* Example: 2026.01.002 (January 2026, patch 2), 2026.02.003 (February 2026, patch 3)
|
||||
* Month and patch are zero-padded. Patch increments with each deployment in a month.
|
||||
*/
|
||||
export const APP_VERSION = '2026.01.1';
|
||||
export const APP_VERSION = '2026.01.002';
|
||||
|
||||
Reference in New Issue
Block a user