bake version into version.ts

Author: brendan-kellam

.env.development

@@ -77,9 +77,6 @@ SOURCEBOT_TELEMETRY_DISABLED=true # Disables telemetry collection
 # Controls the number of concurrent indexing jobs that can run at once
 # INDEX_CONCURRENCY_MULTIPLE=
 
-# Controls the version of the web app
-# NEXT_PUBLIC_SOURCEBOT_VERSION=
-
 # CONFIG_MAX_REPOS_NO_TOKEN=
 NODE_ENV=development
 # SOURCEBOT_TENANCY_MODE=single

.github/workflows/_gcp-deploy.yml

@@ -54,7 +54,6 @@ jobs:
             ${{ env.IMAGE_PATH }}:${{ github.sha }}
             ${{ env.IMAGE_PATH }}:latest
           build-args: |
-            NEXT_PUBLIC_SOURCEBOT_VERSION=${{ github.ref_name }}
             NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT=${{ vars.NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT }}
             NEXT_PUBLIC_SENTRY_ENVIRONMENT=${{ vars.NEXT_PUBLIC_SENTRY_ENVIRONMENT }}
             NEXT_PUBLIC_SENTRY_WEBAPP_DSN=${{ vars.NEXT_PUBLIC_SENTRY_WEBAPP_DSN }}
@@ -65,6 +64,7 @@ jobs:
             SENTRY_ORG=${{ vars.SENTRY_ORG }}
             SENTRY_WEBAPP_PROJECT=${{ vars.SENTRY_WEBAPP_PROJECT }}
             SENTRY_BACKEND_PROJECT=${{ vars.SENTRY_BACKEND_PROJECT }}
+            SENTRY_RELEASE=${{ github.ref_name }}
 
       
       - name: Deploy to GCP

.github/workflows/ghcr-publish.yml

@@ -7,6 +7,12 @@ on:
   push:
     branches: ["main"]
     tags: ["v*.*.*"]
+  workflow_call:
+    inputs:
+      version:
+        description: 'Version tag (e.g., v4.10.5)'
+        required: false
+        type: string
 
 env:
   # Use docker.io for Docker Hub if empty
@@ -40,6 +46,7 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
+          ref: ${{ inputs.version || github.ref_name }}
           submodules: "true"
 
       # Extract metadata (tags, labels) for Docker
@@ -77,8 +84,6 @@ jobs:
           cache-to: type=gha,mode=max,scope=${{ env.PLATFORM_PAIR }}
           platforms: ${{ matrix.platform }}
           outputs: type=image,name=${{ env.REGISTRY_IMAGE }},push-by-digest=true,name-canonical=true,push=true,annotation.org.opencontainers.image.description=Blazingly fast code search
-          build-args: |
-            NEXT_PUBLIC_SOURCEBOT_VERSION=${{ github.ref_name }}
 
       - name: Export digest
         run: |

.github/workflows/release-sourcebot.yml

@@ -41,7 +41,7 @@ jobs:
               exit 1
           fi
 
-      - name: Update CHANGELOG.md
+      - name: Update CHANGELOG.md and version.ts
         run: |
           VERSION="${{ inputs.version }}"
           DATE=$(date +%Y-%m-%d)
@@ -54,15 +54,23 @@ jobs:
           echo "Updated CHANGELOG.md with version $VERSION"
           cat CHANGELOG.md | head -n 15
 
+          # Update version.ts
+          cat > packages/shared/src/version.ts << EOF
+          // This file is auto-generated by .github/workflows/release-sourcebot.yml
+          export const SOURCEBOT_VERSION = "v$VERSION";
+          EOF
+          echo "Updated version.ts with version v$VERSION"
+          cat packages/shared/src/version.ts
+
       - name: Configure git
         run: |
           git config user.name "github-actions[bot]"
           git config user.email "github-actions[bot]@users.noreply.github.com"
 
-      - name: Commit CHANGELOG
+      - name: Commit changes
         run: |
           VERSION="${{ inputs.version }}"
-          git add CHANGELOG.md
+          git add CHANGELOG.md packages/shared/src/version.ts
           git commit -m "Release v$VERSION"
 
       - name: Create annotated tag
@@ -84,3 +92,13 @@ jobs:
               --verify-tag \
               --generate-notes \
               --latest
+
+  publish:
+    needs: release
+    uses: ./.github/workflows/ghcr-publish.yml
+    with:
+      version: v${{ inputs.version }}
+    permissions:
+      contents: read
+      packages: write
+      id-token: write

Dockerfile

@@ -8,7 +8,6 @@
 # in the webapp.
 # @see: https://docs.docker.com/build/building/variables/#scoping
 
-ARG NEXT_PUBLIC_SOURCEBOT_VERSION
 ARG NEXT_PUBLIC_SENTRY_ENVIRONMENT
 ARG NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT
 ARG NEXT_PUBLIC_SENTRY_WEBAPP_DSN
@@ -51,8 +50,6 @@ RUN yarn workspace @sourcebot/query-language install
 FROM node-alpine AS web-builder
 ENV SKIP_ENV_VALIDATION=1
 # -----------
-ARG NEXT_PUBLIC_SOURCEBOT_VERSION
-ENV NEXT_PUBLIC_SOURCEBOT_VERSION=$NEXT_PUBLIC_SOURCEBOT_VERSION
 ARG NEXT_PUBLIC_SENTRY_ENVIRONMENT
 ENV NEXT_PUBLIC_SENTRY_ENVIRONMENT=$NEXT_PUBLIC_SENTRY_ENVIRONMENT
 ARG NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT
@@ -72,7 +69,8 @@ ARG SENTRY_ORG
 ENV SENTRY_ORG=$SENTRY_ORG
 ARG SENTRY_WEBAPP_PROJECT
 ENV SENTRY_WEBAPP_PROJECT=$SENTRY_WEBAPP_PROJECT
-ENV SENTRY_RELEASE=$NEXT_PUBLIC_SOURCEBOT_VERSION
+ARG SENTRY_RELEASE
+ENV SENTRY_RELEASE=$SENTRY_RELEASE
 # SMUAT = Source Map Upload Auth Token
 ARG SENTRY_SMUAT
 ENV SENTRY_SMUAT=$SENTRY_SMUAT
@@ -102,8 +100,6 @@ ENV SKIP_ENV_VALIDATION=0
 FROM node-alpine AS backend-builder
 ENV SKIP_ENV_VALIDATION=1
 # -----------
-ARG NEXT_PUBLIC_SOURCEBOT_VERSION
-ENV NEXT_PUBLIC_SOURCEBOT_VERSION=$NEXT_PUBLIC_SOURCEBOT_VERSION
 
 # To upload source maps to Sentry, we need to set the following build-time args.
 # It's important that we don't set these for oss builds, otherwise the Sentry
@@ -115,6 +111,8 @@ ENV SENTRY_BACKEND_PROJECT=$SENTRY_BACKEND_PROJECT
 # SMUAT = Source Map Upload Auth Token
 ARG SENTRY_SMUAT
 ENV SENTRY_SMUAT=$SENTRY_SMUAT
+ARG SENTRY_RELEASE
+ENV SENTRY_RELEASE=$SENTRY_RELEASE
 # -----------
 
 WORKDIR /app
@@ -132,12 +130,12 @@ RUN yarn workspace @sourcebot/backend install
 RUN yarn workspace @sourcebot/backend build
 
 # Upload source maps to Sentry if we have the necessary build-time args.
-RUN if [ -n "$SENTRY_SMUAT" ] && [ -n "$SENTRY_ORG" ] && [ -n "$SENTRY_BACKEND_PROJECT" ] && [ -n "$NEXT_PUBLIC_SOURCEBOT_VERSION" ]; then \
+RUN if [ -n "$SENTRY_SMUAT" ] && [ -n "$SENTRY_ORG" ] && [ -n "$SENTRY_BACKEND_PROJECT" ] && [ -n "$SENTRY_RELEASE" ]; then \
     apk add --no-cache curl; \
     curl -sL https://sentry.io/get-cli/ | sh; \
     sentry-cli login --auth-token $SENTRY_SMUAT; \
-    sentry-cli sourcemaps inject --org $SENTRY_ORG --project $SENTRY_BACKEND_PROJECT --release $NEXT_PUBLIC_SOURCEBOT_VERSION ./packages/backend/dist; \
-    sentry-cli sourcemaps upload --org $SENTRY_ORG --project $SENTRY_BACKEND_PROJECT --release $NEXT_PUBLIC_SOURCEBOT_VERSION ./packages/backend/dist; \
+    sentry-cli sourcemaps inject --org $SENTRY_ORG --project $SENTRY_BACKEND_PROJECT --release $SENTRY_RELEASE ./packages/backend/dist; \
+    sentry-cli sourcemaps upload --org $SENTRY_ORG --project $SENTRY_BACKEND_PROJECT --release $SENTRY_RELEASE ./packages/backend/dist; \
 fi
 
 ENV SKIP_ENV_VALIDATION=0
@@ -146,8 +144,6 @@ ENV SKIP_ENV_VALIDATION=0
 # ------ Runner ------
 FROM node-alpine AS runner
 # -----------
-ARG NEXT_PUBLIC_SOURCEBOT_VERSION
-ENV NEXT_PUBLIC_SOURCEBOT_VERSION=$NEXT_PUBLIC_SOURCEBOT_VERSION
 ARG NEXT_PUBLIC_SENTRY_ENVIRONMENT
 ENV NEXT_PUBLIC_SENTRY_ENVIRONMENT=$NEXT_PUBLIC_SENTRY_ENVIRONMENT
 ARG NEXT_PUBLIC_SENTRY_WEBAPP_DSN
@@ -160,8 +156,6 @@ ARG NEXT_PUBLIC_LANGFUSE_BASE_URL
 ENV NEXT_PUBLIC_LANGFUSE_BASE_URL=$NEXT_PUBLIC_LANGFUSE_BASE_URL
 # -----------
 
-RUN echo "Sourcebot Version: $NEXT_PUBLIC_SOURCEBOT_VERSION"
-
 WORKDIR /app
 ENV NODE_ENV=production
 ENV NEXT_TELEMETRY_DISABLED=1

entrypoint.sh

@@ -63,8 +63,15 @@ else
     export REDIS_EMBEDDED="false"
 fi
 
+# Extract version from version.ts
+VERSION_FILE="/app/packages/shared/src/version.ts"
+if [ -f "$VERSION_FILE" ]; then
+    SOURCEBOT_VERSION=$(grep -o '"v[^"]*"' "$VERSION_FILE" | tr -d '"')
+else
+    SOURCEBOT_VERSION="unknown"
+fi
 
-echo -e "\e[34m[Info] Sourcebot version: $NEXT_PUBLIC_SOURCEBOT_VERSION\e[0m"
+echo -e "\e[34m[Info] Sourcebot version: $SOURCEBOT_VERSION\e[0m"
 
 if [ -n "$SOURCEBOT_TELEMETRY_DISABLED" ]; then
     # Validate that SOURCEBOT_TELEMETRY_DISABLED is either "true" or "false"
@@ -157,7 +164,7 @@ if [ ! -f "$FIRST_RUN_FILE" ]; then
             "event": "install",
             "distinct_id": "'"$SOURCEBOT_INSTALL_ID"'",
             "properties": {
-                "sourcebot_version": "'"$NEXT_PUBLIC_SOURCEBOT_VERSION"'"
+                "sourcebot_version": "'"$SOURCEBOT_VERSION"'"
             }
         }' https://us.i.posthog.com/capture/ ) then
             echo -e "\e[33m[Warning] Failed to send install event.\e[0m"
@@ -168,8 +175,8 @@ else
     PREVIOUS_VERSION=$(cat "$FIRST_RUN_FILE" | jq -r '.version')
 
     # If the version has changed, we assume an upgrade has occurred.
-    if [ "$PREVIOUS_VERSION" != "$NEXT_PUBLIC_SOURCEBOT_VERSION" ]; then
-        echo -e "\e[34m[Info] Upgraded from version $PREVIOUS_VERSION to $NEXT_PUBLIC_SOURCEBOT_VERSION\e[0m"
+    if [ "$PREVIOUS_VERSION" != "$SOURCEBOT_VERSION" ]; then
+        echo -e "\e[34m[Info] Upgraded from version $PREVIOUS_VERSION to $SOURCEBOT_VERSION\e[0m"
 
         if [ "$SOURCEBOT_TELEMETRY_DISABLED" = "false" ]; then
             if ! ( curl -L --output /dev/null --silent --fail --header "Content-Type: application/json" -d '{
@@ -178,7 +185,7 @@ else
                 "distinct_id": "'"$SOURCEBOT_INSTALL_ID"'",
                 "properties": {
                     "from_version": "'"$PREVIOUS_VERSION"'",
-                    "to_version": "'"$NEXT_PUBLIC_SOURCEBOT_VERSION"'"
+                    "to_version": "'"$SOURCEBOT_VERSION"'"
                 }
             }' https://us.i.posthog.com/capture/ ) then
                 echo -e "\e[33m[Warning] Failed to send upgrade event.\e[0m"
@@ -187,7 +194,7 @@ else
     fi
 fi
 
-echo "{\"version\": \"$NEXT_PUBLIC_SOURCEBOT_VERSION\", \"install_id\": \"$SOURCEBOT_INSTALL_ID\"}" > "$FIRST_RUN_FILE"
+echo "{\"version\": \"$SOURCEBOT_VERSION\", \"install_id\": \"$SOURCEBOT_INSTALL_ID\"}" > "$FIRST_RUN_FILE"
 
 # Start the database and wait for it to be ready before starting any other service
 if [ "$DATABASE_EMBEDDED" = "true" ]; then

packages/backend/src/instrument.ts

@@ -1,13 +1,13 @@
 import * as Sentry from "@sentry/node";
-import { createLogger } from "@sourcebot/shared";
+import { createLogger, SOURCEBOT_VERSION } from "@sourcebot/shared";
 import { env } from "@sourcebot/shared/client";
 
 const logger = createLogger('instrument');
 
 if (!!env.NEXT_PUBLIC_SENTRY_BACKEND_DSN && !!env.NEXT_PUBLIC_SENTRY_ENVIRONMENT) {
     Sentry.init({
         dsn: env.NEXT_PUBLIC_SENTRY_BACKEND_DSN,
-        release: env.NEXT_PUBLIC_SOURCEBOT_VERSION,
+        release: SOURCEBOT_VERSION,
         environment: env.NEXT_PUBLIC_SENTRY_ENVIRONMENT,
     });
 } else {

packages/backend/src/posthog.ts

@@ -1,5 +1,4 @@
-import { env as clientEnv } from "@sourcebot/shared/client";
-import { env } from "@sourcebot/shared";
+import { env, SOURCEBOT_VERSION } from "@sourcebot/shared";
 import { PostHog } from 'posthog-node';
 import { PosthogEvent, PosthogEventMap } from './posthogEvents.js';
 
@@ -24,7 +23,7 @@ export function captureEvent<E extends PosthogEvent>(event: E, properties: Posth
         event: event,
         properties: {
             ...properties,
-            sourcebot_version: clientEnv.NEXT_PUBLIC_SOURCEBOT_VERSION,
+            sourcebot_version: SOURCEBOT_VERSION,
         },
     });
 }

packages/shared/src/env.client.ts

@@ -6,15 +6,13 @@ export const env = createEnv({
     clientPrefix: "NEXT_PUBLIC_",
     client: {
         NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT: z.enum(SOURCEBOT_CLOUD_ENVIRONMENT).optional(),
-        NEXT_PUBLIC_SOURCEBOT_VERSION: z.string().default("unknown"),
         NEXT_PUBLIC_SENTRY_BACKEND_DSN: z.string().optional(),
         NEXT_PUBLIC_SENTRY_ENVIRONMENT: z.string().optional(),
         NEXT_PUBLIC_LANGFUSE_PUBLIC_KEY: z.string().optional(),
         NEXT_PUBLIC_LANGFUSE_BASE_URL: z.string().optional()
     },
     runtimeEnvStrict: {
         NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT: process.env.NEXT_PUBLIC_SOURCEBOT_CLOUD_ENVIRONMENT,
-        NEXT_PUBLIC_SOURCEBOT_VERSION: process.env.NEXT_PUBLIC_SOURCEBOT_VERSION,
         NEXT_PUBLIC_SENTRY_BACKEND_DSN: process.env.NEXT_PUBLIC_SENTRY_BACKEND_DSN,
         NEXT_PUBLIC_SENTRY_ENVIRONMENT: process.env.NEXT_PUBLIC_SENTRY_ENVIRONMENT,
         NEXT_PUBLIC_LANGFUSE_PUBLIC_KEY: process.env.NEXT_PUBLIC_LANGFUSE_PUBLIC_KEY,

packages/shared/src/index.client.ts

@@ -1,4 +1,7 @@
 export * from "./constants.js";
 export {
     env
-} from "./env.client.js";
+} from "./env.client.js";
+export {
+    SOURCEBOT_VERSION,
+} from "./version.js";