Skip to content

Commit 440baca

Browse files
authored
Merge pull request #167 from strick-j/develop
Merge develop into main
2 parents b3ef10e + bf23ed0 commit 440baca

File tree

4 files changed

+26
-6
lines changed

4 files changed

+26
-6
lines changed

CLAUDE.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ lab-visualizer/
273273
274274
├── docker-compose.yml # Local development setup
275275
├── Makefile # Task automation
276-
├── VERSION # Application version (e.g. 1.4.0)
276+
├── VERSION # Application version (e.g. 1.5.0)
277277
├── README.md # User documentation
278278
├── CLAUDE.md # This file (AI assistant context)
279279
├── CONTRIBUTING.md # Contributing guidelines
@@ -549,6 +549,11 @@ See `.env.example` for complete list. Key variables:
549549
- **Before every commit**, run `cd frontend && npx vitest run` and ensure all tests pass. Do not commit if any tests fail
550550
- **Before every commit**, run `cd frontend && npx tsc --noEmit` and ensure there are no TypeScript errors
551551

552+
### Pre-Merge Checklist (main)
553+
- **Before merging to `main`**, verify that `VERSION` (root) and `frontend/package.json` `"version"` values match
554+
- **Before merging to `main`**, verify the version has been bumped appropriately for the scope of changes (MAJOR / MINOR / PATCH per SemVer)
555+
- The backend (`backend/app/version.py`) reads the `VERSION` file dynamically — it does not need a manual update
556+
552557
### Security Considerations
553558
- Never commit secrets or credentials
554559
- AWS credentials via IAM roles in production

CONTRIBUTING.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,11 @@ This project follows [Semantic Versioning](https://semver.org/) (SemVer) with th
3434

3535
Version numbers are maintained in the following locations and must be kept in sync:
3636

37-
| File | Field |
38-
|------|-------|
39-
| `frontend/package.json` | `"version"` |
40-
| `backend/app/main.py` | `version` parameter in FastAPI app initialization |
37+
| File | Field | Notes |
38+
|------|-------|-------|
39+
| `VERSION` (root) | Plain text version string | **Source of truth** — read by backend and CI |
40+
| `frontend/package.json` | `"version"` | Must be updated manually to match `VERSION` |
41+
| `backend/app/main.py` | `version` parameter in FastAPI app | Reads from `VERSION` via `version.py` — no manual update needed |
4142

4243
### Release Process
4344

@@ -46,6 +47,14 @@ Version numbers are maintained in the following locations and must be kept in sy
4647
3. Releases are tagged on `main` using the format `vMAJOR.MINOR.PATCH` (e.g., `v1.1.0`).
4748
4. Docker images are tagged automatically by CI using the git commit SHA and branch metadata. The `latest` tag is applied to builds from the `main` branch.
4849

50+
### Pre-Merge Checklist
51+
52+
Before merging to `main`, verify:
53+
54+
- [ ] `VERSION` and `frontend/package.json` `"version"` values match
55+
- [ ] Version has been bumped appropriately for the scope of changes (MAJOR / MINOR / PATCH per SemVer)
56+
- [ ] All CI checks pass (lint, type-check, tests, security scans)
57+
4958
### Support Policy
5059

5160
Only the latest released version receives security updates and bug fixes. See [SECURITY.md](SECURITY.md) for details on reporting vulnerabilities.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,12 @@ terraform apply
497497

498498
See [infrastructure/README.md](infrastructure/README.md) for detailed deployment instructions.
499499

500+
## Versioning
501+
502+
This project follows [Semantic Versioning](https://semver.org/) (MAJOR.MINOR.PATCH). The `VERSION` file in the repository root is the source of truth — the backend reads it dynamically via `backend/app/version.py`, and CI uses it for image tagging. The `frontend/package.json` `"version"` field must be kept in sync manually.
503+
504+
See [CONTRIBUTING.md](CONTRIBUTING.md) for the full release process and pre-merge checklist.
505+
500506
## Required Permissions
501507

502508
### AWS IAM Permissions

frontend/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "aws-infra-visualizer-frontend",
33
"private": true,
4-
"version": "1.4.1",
4+
"version": "1.5.0",
55
"type": "module",
66
"scripts": {
77
"dev": "vite",

0 commit comments

Comments
 (0)