Configure S3 to sync to a specific endpoint (#177)

    Syncs build to new R2 bucket, using the S3 compatibility layer
    Adds AWS_ENDPOINT secret to ensure we send stuff to the correct API
    Moves all branches to the branches deploy directory, and all releases to the releases deploy directory,

i.e.

    tag v0.x.0 will get deployed to prod_r2_bucket/releases/v0.x.0
    branch foo will get deployed to staging_r2_bucket/branches/foo

Branches are not deployed to the prod bucket, and releases are not deployed to staging. The intention is that staging tracks main (i.e. branches/main) and prod tracks the latest release from the KV store.

Author: patch0

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

@@ -41,6 +41,8 @@ on:
         required: true
       AWS_SECRET_ACCESS_KEY:
         required: true
+      AWS_ENDPOINT:
+        required: true
 
 jobs:
   build-deploy:
@@ -58,13 +60,6 @@ jobs:
         node-version: 16
         cache: 'yarn'
 
-    - name: Configure AWS credentials
-      uses: aws-actions/configure-aws-credentials@v1
-      with:
-        aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-        aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-        aws-region: ${{ secrets.AWS_REGION }}
-
     - name: Install code
       run: yarn install --frozen-lock-file
 
@@ -81,4 +76,8 @@ jobs:
         REACT_APP_LOGIN_ENABLED: ${{ inputs.react_app_login_enabled }}
 
     - name: Deploy site to S3 bucket
-      run: aws s3 sync ./build/ s3://${{ secrets.AWS_S3_BUCKET }}/${{ inputs.deploy_dir }} --delete
+      run: aws s3 sync  ./build/ s3://${{ secrets.AWS_S3_BUCKET }}/${{ inputs.deploy_dir }} --delete --endpoint ${{ secrets.AWS_ENDPOINT }}
+      env:
+        AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+        AWS_REGION: ${{ secrets.AWS_REGION }}

.github/workflows/main.yml

@@ -90,36 +90,36 @@ jobs:
           cypress/videos
 
 
-  build-and-deploy-release:
+  build-and-deploy-tag:
     if: github.ref_type == 'tag'
     needs:
       - test
     uses: ./.github/workflows/build-and-deploy.yml
     with:
-      deploy_dir: ${{ github.ref_name }}
+      deploy_dir: releases/${{ github.ref_name }}
       environment: production
-      public_url: https://editor.raspberrypi.org/${{ github.ref_name }}
+      public_url: https://editor.raspberrypi.org/releases/${{ github.ref_name }}
       react_app_api_endpoint: https://editor-api.raspberrypi.org
       react_app_authentication_url: https://auth-v1.raspberrypi.org
     secrets: inherit
 
-  build-and-deploy-staging:
-    if: github.ref == 'refs/heads/main'
+  build-and-deploy-main:
+    if: github.ref_type == 'branch' && github.ref_name == 'main'
     needs:
       - test
     uses: ./.github/workflows/build-and-deploy.yml
     with:
-      deploy_dir: ${{ github.ref_name }}
+      deploy_dir: branches/${{ github.ref_name }}
       environment: staging
-      public_url: https://staging-editor.raspberrypi.org/${{ github.ref_name }}
+      public_url: https://staging-editor.raspberrypi.org/branches/${{ github.ref_name }}
     secrets: inherit
 
-  build-and-deploy-preview:
-    if: github.ref_type == 'branch' && github.ref != 'refs/heads/main'
+  build-and-deploy-branch:
+    if: github.ref_type == 'branch' && github.ref_name != 'main'
     uses: ./.github/workflows/build-and-deploy.yml
     with:
-      deploy_dir: previews/${{ github.ref_name }}
+      deploy_dir: branches/${{ github.ref_name }}
       environment: previews/${{ github.ref_name }}
-      public_url: http://python-editor-dist-test.s3-website.eu-west-2.amazonaws.com/previews/${{ github.ref_name }}
+      public_url: https://staging-editor.raspberrypi.org/branches/${{ github.ref_name }}
     secrets: inherit
 

CHANGELOG.md

@@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Changed
 - Update styling on the `sense_hat` visual output (#174)
 - Update build workflow with a reusable job to update preview, staging, and prod (#176)
+- Change deployment to use specific AWS endpoint, and deploy releases to `/releases/...` and branches to `/branches/..` (#177)
 
 ## [0.3.0]