Skip to content

docs: Update for semantic versioning [doc-updater] #499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
james-in-a-box wants to merge 1 commit into from
Closed

docs: Update for semantic versioning [doc-updater] #499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/development/STRUCTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ Key workflows for the SDLC pipeline (see `.github/workflows/` for complete list)
│ ├── merge_conflict_check.py # Merge conflict detection
│ ├── plan_yaml_check.py # Plan YAML validation
│ └── test_check.py # Test execution check
├── create-release.sh # Semantic versioning release creation
├── push-contract-update.sh # Conflict-resistant contract push utility
├── setup-sdlc-labels.sh # SDLC label setup (idempotent)
└── transition-sdlc-label.sh # Atomic SDLC label transitions
Expand Down
33 changes: 30 additions & 3 deletions docs/guides/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,26 +166,53 @@ jobs:

## Pre-built Images

Pre-built images are available on GHCR:
Pre-built images are available on GHCR with semantic version tags:

| Image | Description |
|-------|-------------|
| `ghcr.io/jwbron/egg-gateway:latest` | Gateway sidecar |
| `ghcr.io/jwbron/egg-sandbox:latest` | Sandbox container |
| `ghcr.io/jwbron/egg-gateway` | Gateway sidecar |
| `ghcr.io/jwbron/egg-sandbox` | Sandbox container |

Images are built on every push to main and on releases.

### Version Tags

Each stable release creates multiple tags following semantic versioning:

```bash
# Latest stable (updated on every stable release)
docker pull ghcr.io/jwbron/egg-sandbox:latest

# Major version (e.g., all v0.x.y updates)
docker pull ghcr.io/jwbron/egg-sandbox:v0

# Minor version (e.g., all v0.1.x updates)
docker pull ghcr.io/jwbron/egg-sandbox:v0.1

# Exact version (immutable)
docker pull ghcr.io/jwbron/egg-sandbox:v0.1.0
```

**Pre-release versions** (e.g., `v1.0.0-beta`) only get the exact version tag and do not update floating tags or `latest`.

### Using Pre-built Images

In your `.env` file:

```bash
# Use latest stable
EGG_GATEWAY_IMAGE=ghcr.io/jwbron/egg-gateway:latest
EGG_SANDBOX_IMAGE=ghcr.io/jwbron/egg-sandbox:latest

# Or pin to a major version for stability
EGG_GATEWAY_IMAGE=ghcr.io/jwbron/egg-gateway:v0
EGG_SANDBOX_IMAGE=ghcr.io/jwbron/egg-sandbox:v0
```

Or specify directly in docker-compose.yml override.

See [RELEASING.md](../../RELEASING.md) for the release process and versioning strategy.

## Configuration Files

### Required Files
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ This index helps both humans and LLMs navigate the documentation efficiently.
|----------|-------------|
| [Project Structure](development/STRUCTURE.md) | Directory conventions and organization |
| [Contributing](../CONTRIBUTING.md) | Development setup, workflow, and PR process |
| [Releasing](../RELEASING.md) | Release process and semantic versioning |

### Guides

Expand Down