Merge pull request #7653 from escattone/fix-dockerflow-version-3144

fix dockerflow __version__ endpoint

Author: akatsoulas

.github/workflows/build-and-push.yml

@@ -44,19 +44,6 @@ jobs:
           REF_ID: ${{ github.event_name == 'workflow_dispatch' && github.event.inputs.ref || github.ref }}
         run: echo "REF_ID=$REF_ID" >> $GITHUB_ENV
 
-      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
-        with:
-          persist-credentials: false
-      - name: Create version.json
-        run: |
-          # create a version.json per
-          # https://github.com/mozilla-services/Dockerflow/blob/master/docs/version_object.md
-          printf '{"commit":"%s","version":"%s","source":"%s","build":"%s"}\n' \
-          "$GITHUB_SHA" \
-          "$GITHUB_REF_NAME" \
-          "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY" \
-          "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID" > version.json
-
       - id: checkout_application_repo
         name: checkout application repo
         uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
@@ -113,6 +100,19 @@ jobs:
           username: oauth2accesstoken
           password: ${{ steps.gcp_auth.outputs.access_token }}
 
+      - name: Create version.json
+        run: |
+          # create a version.json per
+          # https://github.com/mozilla-services/Dockerflow/blob/master/docs/version_object.md
+          # Must run AFTER the final checkout: actions/checkout defaults to
+          # clean=true, which `git clean`s this untracked file. Creating it here,
+          # right before the build, ensures it lands in the image via `COPY . .`.
+          printf '{"commit":"%s","version":"%s","source":"%s","build":"%s"}\n' \
+          "$GITHUB_SHA" \
+          "$GITHUB_REF_NAME" \
+          "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY" \
+          "$GITHUB_SERVER_URL/$GITHUB_REPOSITORY/actions/runs/$GITHUB_RUN_ID" > version.json
+
       - id: build_and_push
         name: Build and push image
         uses: docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25 # v5

kitsune/settings.py

@@ -32,6 +32,12 @@
 # Repository directory.
 ROOT = os.path.dirname(os.path.dirname(__file__))
 
+# Dockerflow's `/__version__` view reads `version.json` from `settings.BASE_DIR`
+# (see dockerflow.django.views.version). CI writes that file to the repo root,
+# which is `ROOT`, so point BASE_DIR there. Without this the view raises
+# AttributeError and `/__version__` returns a 500.
+BASE_DIR = ROOT
+
 # Django project directory.
 PROJECT_ROOT = os.path.dirname(__file__)