diff --git a/.github/workflows/README.md b/.github/workflows/README.md index b0548b3..74dac2d 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -15,7 +15,7 @@ Use this for all version releases: - ✅ Updates chart version - ✅ Creates git tag - ✅ Builds Docker image with all proper tags -- ✅ Publishes Helm chart to GHCR +- ✅ Publishes Helm chart to GitHub Pages (`https://cpfarhood.github.io/devcontainer`) - ✅ Creates GitHub Release with changelog - ✅ No more `[skip ci]` blocking builds! diff --git a/CLAUDE.md b/CLAUDE.md index 4cd405b..5a6ad66 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -190,14 +190,16 @@ helm install my-devcontainer ./chart -f custom-values.yaml ### CI/CD -- **`build-and-push.yaml`** — Builds and pushes to GHCR on every push to `main`, version tags (`v*`), and PRs. For version tags, also creates GitHub Release with Helm chart after Docker build completes. Tags: `latest` (main), semver, branch name, commit SHA. +- **`build-and-push.yaml`** — Builds and pushes to GHCR on every push to `main`, version tags (`v*`), and PRs. Tags: `latest` (main), semver, branch name, commit SHA. +- **`release-unified.yaml`** — Manual release workflow: bumps chart version, builds Docker image, publishes Helm chart to GitHub Pages (`https://cpfarhood.github.io/devcontainer`), and creates GitHub Release. - **`dependabot.yml`** — Weekly updates for GitHub Actions and Docker base image. Image registry: `ghcr.io/cpfarhood/devcontainer` +Helm repo: `https://cpfarhood.github.io/devcontainer` ## Kubernetes Notes -- Deployed via Helm chart (`chart/`), published as OCI artifact to GHCR, reconciled by Flux +- Deployed via Helm chart (`chart/`), published to GitHub Pages Helm repo, reconciled by Flux - Storage class is `ceph-filesystem` by default — change via `storage.className` in values - Resource limits: 1–4 CPU, 2–8Gi memory - Health checks (liveness/readiness probes) on port 5800 diff --git a/README.md b/README.md index 659aa64..1da476f 100644 --- a/README.md +++ b/README.md @@ -14,23 +14,30 @@ A containerized cloud development environment with web-based GUI access, featuri ## Quick Start -### Option A: Quickstart (Recommended) - -For 80% of users, use the simplified quickstart values: +### Option A: Install from Helm Repo (Recommended) ```bash -# Copy and customize the quickstart template +# Add the Helm repository +helm repo add devcontainer https://cpfarhood.github.io/devcontainer +helm repo update + +# Deploy with one command +helm install mydev devcontainer/devcontainer \ + --set name=mydev \ + --set githubRepo=https://github.com/youruser/yourrepo +``` + +### Option B: Install from Source + +```bash +# Clone and customize the quickstart template cp chart/values-quickstart.yaml my-values.yaml +# Edit my-values.yaml to set your name and repository -# Edit my-values.yaml to set your name and repository: -# name: mydev -# githubRepo: https://github.com/youruser/yourrepo - -# Deploy with minimal configuration helm install mydev ./chart -f my-values.yaml ``` -### Option B: One-Command Deploy +### Option C: One-Command from Source ```bash helm install mydev ./chart \