Cleanup template (#161)

Author: cal-overflow

Diff for: .github/workflows/delete-deploy-preview.yml renamed to .github/workflows/template.delete-deploy-preview.yml

@@ -13,10 +13,10 @@ permissions:
 env:
   STACK_NAME: portfolio-template
   REGION: us-east-1
-  DOMAIN: portfolio.cal-overflow.dev
-  NUXT_ENV_SITE_URL: https://portfolio.cal-overflow.dev # This value does not matter here
+  NUXT_ENV_SITE_URL: https://portfolio.cal-overflow.dev
   NUXT_ENV_FULL_NAME: Example Portfolio
   NUXT_ENV_EMAIL_ADDRESS: [email protected]
+  STACK_TEMPLATE_FILE: template/stack.yml
 
 jobs:
   acceptance:
@@ -55,21 +55,8 @@ jobs:
           aws-region: ${{ env.REGION }}
 
       - name: Deploy stack
-        run: |
-          sam deploy --stack-name $STACK_NAME --region $REGION --parameter-overrides "Domain=$DOMAIN"
-
-      - name: Build and deploy static site
-        run: |
-          mkdir example_content
-          git clone https://github.com/cal-overflow/example-portfolio-content.git example_content
-          cp -r example_content/content/* src/content
-          cp -r example_content/assets/* src/assets
-
-          npm ci
-          npm run generate
-
-          BUCKET=$(aws cloudformation describe-stacks --stack-name=$STACK_NAME --region $REGION --query 'Stacks[0].Outputs[?OutputKey==`S3BucketName`].OutputValue' --output text)
-          aws s3 sync dist s3://$BUCKET
+        run: ./template/deploy.sh
+        shell: bash
 
   run_e2e_tests:
     needs: deploy

Diff for: .github/workflows/deploy.yml renamed to .github/workflows/template.deploy.yml

@@ -16,6 +16,7 @@ env:
   REGION: us-east-1
   NUXT_ENV_FULL_NAME: 'Pull Request #${{ github.event.number }}'
   NUXT_ENV_EMAIL_ADDRESS: [email protected]
+  STACK_TEMPLATE_FILE: template/pr.stack.yml
 
 jobs:
   acceptance:
@@ -60,19 +61,8 @@ jobs:
 
       - name: Deploy stack & publish site
         id: sam-deploy
-        run: |
-          sam deploy --stack-name $STACK_NAME --region $REGION -t pr.template.yml
-
-          mkdir example_content
-          git clone https://github.com/cal-overflow/example-portfolio-content.git example_content
-          cp -r example_content/content/* src/content
-          cp -r example_content/assets/* src/assets
-
-          npm ci
-          npm run generate
-
-          BUCKET=$(aws cloudformation describe-stacks --stack-name=$STACK_NAME --region $REGION --query 'Stacks[0].Outputs[?OutputKey==`S3BucketName`].OutputValue' --output text)
-          aws s3 sync dist s3://$BUCKET
+        run: ./template/deploy.sh
+        shell: bash
 
       - name: Generate Github Actions summary
         id: generate-summary
@@ -94,7 +84,7 @@ jobs:
           message: |
             ### Deploy Preview
             **Status:** ${{ steps.sam-deploy.outcome }}
-            **URL:** [${{ env.URL }}](${{ env.URL}})
+            **URL:** [${{ env.URL }}](${{ env.URL }})
       
 
   run_e2e_tests:

Diff for: .github/workflows/pr-validator.yml renamed to .github/workflows/template.pr-validation.yml

@@ -1,12 +1,8 @@
 ## Template files:
-src/content/*
-
 !.gitkeep
 !.gitignore
 
 
-
-
 # Created by .ignore support plugin (hsz.mobi)
 ### Node template
 # Logs

Diff for: .gitignore

@@ -9,10 +9,10 @@ Built primarily with [NuxtJS](https://nuxtjs.org/) and [TailwindCSS](https://tai
 
 View the source code for the website [here](https://github.com/cal-overflow/site)
 #### Light mode
-[![Picture of home screen (light mode)](assets/preview-home-page-light.png)](http://www.cal-overflow.dev)
+[![Picture of home screen (light mode)](template/assets/preview-home-page-light.png)](http://www.cal-overflow.dev)
 
 #### Dark mode
-[![Picture of home screen (dark mode)](assets/preview-home-page-dark.png)](http://www.cal-overflow.dev)
+[![Picture of home screen (dark mode)](template/assets/preview-home-page-dark.png)](http://www.cal-overflow.dev)
 
 </details>
 
@@ -165,7 +165,7 @@ I have created a [custom Editor component](src/components/development/Editor.vue
 
 | Viewing post | Editing Post |
 | :-: | :-: |
-| ![Viewing post](assets/viewing-post-example.png) | ![Editing post](assets/editing-post-example.png) |
+| ![Viewing post](template/assets/viewing-post-example.png) | ![Editing post](template/assets/editing-post-example.png) |
 
 </details>
 

Diff for: README.md

@@ -0,0 +1,21 @@
+# Template files
+
+The files within this folder are specific to the template. You can safely ignore the contents within this folder.
+
+### About these files
+
+#### `assets/`
+Images used in the template repository [README.md](../README.md)
+
+#### `stack.yml`
+The AWS Cloudformation stack for the [portfolio.cal-overflow.dev](https://portfolio.cal-overflow.dev) template site.
+
+#### `pr.stack.yml`
+The AWS Cloudformation stack for the PR deploy previews.
+
+#### `samconfig.toml`
+The [AWS SAM](https://aws.amazon.com/serverless/sam/) configuration file.
+
+#### `deploy.sh`
+Bash script reused by workflows when deploying the Cloudformation stack and syncing the static website in an S3 bucket.
+

Diff for: template/README.md

@@ -0,0 +1,18 @@
+
+sam deploy \
+  -t $STACK_TEMPLATE_FILE \
+  --stack-name $STACK_NAME \
+  --config-file ./samconfig.toml \
+  --region $REGION
+
+mkdir example_content
+git clone https://github.com/cal-overflow/example-portfolio-content.git example_content
+cp -r example_content/content/* src/content
+cp -r example_content/assets/* src/assets
+
+npm ci
+npm run generate
+
+BUCKET=$(aws cloudformation describe-stacks --stack-name=$STACK_NAME --region $REGION --query 'Stacks[0].Outputs[?OutputKey==`S3BucketName`].OutputValue' --output text)
+aws s3 sync dist s3://$BUCKET
+

Diff for: assets/editing-post-example.png renamed to template/assets/editing-post-example.png

@@ -4,7 +4,7 @@ Description: "AWS resources for a static website with a custom domain"
 Parameters:
   Domain:
     Type: String
-    Default: cal-overflow.dev
+    Default: portfolio.cal-overflow.dev
 
   HostedZone:
     Type: String