chore: add proper redirects for non-prod docs envs (#3242)

vuestorefront · Nov 13, 2024 · 6d69b69 · 6d69b69
1 parent d2d8eef
commit 6d69b69
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 3 deletions.
diff --git a/.github/workflows/deploy-docs-vue-storefront-cloud.yml b/.github/workflows/deploy-docs-vue-storefront-cloud.yml
@@ -21,6 +21,7 @@ jobs:
       ARTIFACT_TYPE: 'sfui2-docs'
       DOCKERFILE_PATH: './.vuestorefrontcloud/docs/Dockerfile'
       ENVIRONMENT: ${{ needs.configure-enviroment.outputs.environment }}
+      TARGET_DOMAIN: ${{ needs.configure-enviroment.outputs.target-domain }}
 
   sync-assets:
     needs: [build, configure-enviroment]

diff --git a/.github/workflows/deploy-router-vue-storefront-cloud.yml b/.github/workflows/deploy-router-vue-storefront-cloud.yml
@@ -21,6 +21,7 @@ jobs:
       ARTIFACT_TYPE: "vue-storefront"
       DOCKERFILE_PATH: ".vuestorefrontcloud/router/docker/Dockerfile"
       ENVIRONMENT: ${{ needs.configure-enviroment.outputs.environment }}
+      TARGET_DOMAIN: ${{ needs.configure-enviroment.outputs.target-domain }}
 
   deploy:
     runs-on: ubuntu-latest

diff --git a/.github/workflows/deploy-test-next-storefront-cloud.yml b/.github/workflows/deploy-test-next-storefront-cloud.yml
@@ -21,6 +21,7 @@ jobs:
       ARTIFACT_TYPE: "sfui2-docs-react"
       DOCKERFILE_PATH: ".vuestorefrontcloud/test-next/docker/Dockerfile"
       ENVIRONMENT: ${{ needs.configure-enviroment.outputs.environment }}
+      TARGET_DOMAIN: ${{ needs.configure-enviroment.outputs.target-domain }}
 
   deploy:
     needs: [ build, configure-enviroment ]

diff --git a/.github/workflows/deploy-test-nuxt-storefront-cloud.yml b/.github/workflows/deploy-test-nuxt-storefront-cloud.yml
@@ -20,6 +20,7 @@ jobs:
       ARTIFACT_TYPE: "sfui2-docs-vue"
       DOCKERFILE_PATH: ".vuestorefrontcloud/test-nuxt/docker/Dockerfile"
       ENVIRONMENT: ${{ needs.configure-enviroment.outputs.environment }}
+      TARGET_DOMAIN: ${{ needs.configure-enviroment.outputs.target-domain }}
 
   deploy:
     needs: [ build, configure-enviroment ]

diff --git a/.github/workflows/image-build-vue-storefront-cloud.yml b/.github/workflows/image-build-vue-storefront-cloud.yml
@@ -14,6 +14,9 @@ on:
       ENVIRONMENT:
         required: true
         type: string
+      TARGET_DOMAIN:
+        required: true
+        type: string
 
 jobs:
   build:
@@ -29,11 +32,12 @@ jobs:
         uses: elgohr/Publish-Docker-Github-Action@v5
         env:
           ENVIRONMENT: ${{ inputs.ENVIRONMENT }}
+          TARGET_DOMAIN: ${{ inputs.TARGET_DOMAIN }}
         with:
           name: ${{ inputs.DOCKER_NAMESPACE }}/${{ inputs.ARTIFACT_TYPE }}:${{ github.sha }}
           registry: registry.storefrontcloud.io
           username: ${{ secrets.CLOUD_USERNAME }}
           password: ${{ secrets.CLOUD_PASSWORD }}
           dockerfile: ${{ inputs.DOCKERFILE_PATH }}
           buildoptions: '--compress'
-          buildargs: VITE_DOCS_BASEPATH,VITE_DOCS_EXAMPLES_REACT_PATH,VITE_DOCS_EXAMPLES_VUE_PATH,ENVIRONMENT
+          buildargs: VITE_DOCS_BASEPATH,VITE_DOCS_EXAMPLES_REACT_PATH,VITE_DOCS_EXAMPLES_VUE_PATH,ENVIRONMENT,TARGET_DOMAIN
diff --git a/.vuestorefrontcloud/router/docker/Dockerfile b/.vuestorefrontcloud/router/docker/Dockerfile
@@ -1,2 +1,9 @@
 FROM nginx
-COPY .vuestorefrontcloud/router/docker/default.conf /etc/nginx/conf.d/default.conf
+
+ARG TARGET_DOMAIN
+
+ENV TARGET_DOMAIN=$TARGET_DOMAIN
+
+COPY .vuestorefrontcloud/router/docker/default.conf.template /etc/nginx/conf.d/default.conf.template
+
+RUN envsubst < /etc/nginx/conf.d/default.conf.template > /etc/nginx/conf.d/default.conf
diff --git a/...torefrontcloud/router/docker/default.conf → ...cloud/router/docker/default.conf.template b/...torefrontcloud/router/docker/default.conf → ...cloud/router/docker/default.conf.template
@@ -8,6 +8,6 @@ server {
 
   # https://www.oliverdavies.uk/blog/nginx-redirects-query-string-arguments
   location / {
-    return 301 https://docs.storefrontui.io/v2$uri$is_args$args;
+    return 301 ${TARGET_DOMAIN}/v2$uri$is_args$args;
   }
 }