feat(sync): default sidecar tag to okdev binary version

Author: acmore

.github/workflows/syncthing-image.yml

@@ -10,10 +10,7 @@ on:
   push:
     branches: [main]
     tags:
-      - 'syncthing-v*'
-    paths:
-      - 'infra/syncthing/**'
-      - '.github/workflows/syncthing-image.yml'
+      - "v*"
 
 jobs:
   build-and-push:
@@ -28,14 +25,12 @@ jobs:
         id: vars
         shell: bash
         run: |
-          if [[ "${GITHUB_REF}" == refs/tags/syncthing-v* ]]; then
-            version="${GITHUB_REF_NAME#syncthing-}"
-          elif [[ -n "${{ github.event.inputs.syncthing_version }}" ]]; then
-            version="${{ github.event.inputs.syncthing_version }}"
+          if [[ -n "${{ github.event.inputs.syncthing_version }}" ]]; then
+            syncthing_version="${{ github.event.inputs.syncthing_version }}"
           else
-            version="v1.29.7"
+            syncthing_version="v1.29.7"
           fi
-          echo "version=${version}" >> "$GITHUB_OUTPUT"
+          echo "syncthing_version=${syncthing_version}" >> "$GITHUB_OUTPUT"
 
       - uses: docker/setup-qemu-action@v3
       - uses: docker/setup-buildx-action@v3
@@ -55,8 +50,8 @@ jobs:
           tags: |
             type=raw,value=edge,enable={{is_default_branch}}
             type=sha,prefix=edge-
-            type=match,pattern=syncthing-(v.*),group=1
-            type=raw,value=latest,enable=${{ startsWith(github.ref, 'refs/tags/syncthing-v') }}
+            type=ref,event=tag
+            type=raw,value=latest,enable=${{ startsWith(github.ref, 'refs/tags/v') }}
 
       - name: Build and push
         uses: docker/build-push-action@v6
@@ -66,6 +61,6 @@ jobs:
           platforms: linux/amd64,linux/arm64
           push: true
           build-args: |
-            SYNCTHING_VERSION=${{ steps.vars.outputs.version }}
+            SYNCTHING_VERSION=${{ steps.vars.outputs.syncthing_version }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

docs/quickstart.md

@@ -63,7 +63,7 @@ For a named session:
 ```
 
 `okdev` auto-installs local Syncthing and auto-injects a pod sidecar when `sync.engine=syncthing`.
-Default sidecar image is `ghcr.io/<repo-owner>/okdev:<version>`; update `spec.sync.syncthing.image` if you publish under a different registry.
+Default sidecar image tag follows the running `okdev` binary version (`ghcr.io/<repo-owner>/okdev:<okdev-version>`). For dev builds, fallback is `ghcr.io/<repo-owner>/okdev:edge`. Update `spec.sync.syncthing.image` only if you publish to a different registry/repository.
 
 Preview-only mode (no cluster changes):
 

docs/release.md

@@ -31,6 +31,15 @@ git push origin v0.1.0
    - `okdev_<os>_<arch>.tar.gz`
    - `checksums.txt`
 
+## Sidecar image tags
+
+The sidecar image tag is aligned with the `okdev` release tag:
+
+- release `vX.Y.Z` publishes `ghcr.io/acmore/okdev:vX.Y.Z`
+- dev/main pushes publish `ghcr.io/acmore/okdev:edge`
+
+`okdev` resolves default sidecar image from its own binary version, with `edge` fallback for dev builds.
+
 ## Install from release
 
 ```bash

internal/config/config.go

@@ -5,15 +5,19 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/acmore/okdev/internal/version"
 	corev1 "k8s.io/api/core/v1"
 )
 
 const (
-	DefaultSyncthingVersion = "v1.29.7"
-	DefaultSyncthingImage   = "ghcr.io/acmore/okdev:" + DefaultSyncthingVersion
-	DefaultWorkspacePVCSize = "50Gi"
+	DefaultSyncthingVersion         = "v1.29.7"
+	DefaultSyncthingImageRepository = "ghcr.io/acmore/okdev"
+	DefaultSyncthingImageFallback   = "edge"
+	DefaultWorkspacePVCSize         = "50Gi"
 )
 
+var DefaultSyncthingImage = DefaultSyncthingImageForBinaryVersion(version.Version)
+
 // DevEnvironment is the top-level config structure for .okdev.yaml.
 type DevEnvironment struct {
 	APIVersion string     `yaml:"apiVersion"`
@@ -107,7 +111,7 @@ func (d *DevEnvironment) SetDefaults() {
 		d.Spec.Sync.Syncthing.AutoInstall = &v
 	}
 	if d.Spec.Sync.Syncthing.Image == "" {
-		d.Spec.Sync.Syncthing.Image = DefaultSyncthingImage
+		d.Spec.Sync.Syncthing.Image = DefaultSyncthingImageForBinaryVersion(version.Version)
 	}
 	if d.Spec.SSH.User == "" {
 		d.Spec.SSH.User = "root"
@@ -217,3 +221,11 @@ func validatePortRange(field string, port int) error {
 	}
 	return nil
 }
+
+func DefaultSyncthingImageForBinaryVersion(binaryVersion string) string {
+	tag := strings.TrimSpace(binaryVersion)
+	if tag == "" || tag == "unknown" || strings.Contains(tag, "dev") {
+		tag = DefaultSyncthingImageFallback
+	}
+	return DefaultSyncthingImageRepository + ":" + tag
+}

internal/config/config_test.go

@@ -1,6 +1,10 @@
 package config
 
-import "testing"
+import (
+	"testing"
+
+	"github.com/acmore/okdev/internal/version"
+)
 
 func validConfig() *DevEnvironment {
 	return &DevEnvironment{
@@ -32,6 +36,9 @@ func TestSetDefaults(t *testing.T) {
 	if cfg.Spec.Sync.Engine != "syncthing" {
 		t.Fatalf("sync engine default not set: %q", cfg.Spec.Sync.Engine)
 	}
+	if cfg.Spec.Sync.Syncthing.Image != DefaultSyncthingImageForBinaryVersion(version.Version) {
+		t.Fatalf("sync image default not set: %q", cfg.Spec.Sync.Syncthing.Image)
+	}
 	if !cfg.Spec.Sync.Syncthing.AutoInstallEnabled() {
 		t.Fatal("expected syncthing autoinstall default true")
 	}
@@ -90,3 +97,12 @@ func TestValidateRejectsInvalidSSHPort(t *testing.T) {
 		t.Fatal("expected validation error")
 	}
 }
+
+func TestDefaultSyncthingImageForBinaryVersion(t *testing.T) {
+	if got := DefaultSyncthingImageForBinaryVersion("v0.2.1"); got != "ghcr.io/acmore/okdev:v0.2.1" {
+		t.Fatalf("unexpected image for release version: %s", got)
+	}
+	if got := DefaultSyncthingImageForBinaryVersion("0.0.0-dev"); got != "ghcr.io/acmore/okdev:edge" {
+		t.Fatalf("unexpected image for dev version: %s", got)
+	}
+}