Set up CD/CI for Backend & Types (#30)

uoa-compsci399-s1-2024 · Apr 1, 2024 · 634413e · 634413e
2 parents 84e7a15 + 1e748d7
commit 634413e
Show file tree

Hide file tree

Showing 65 changed files with 133 additions and 23 deletions.
diff --git a/.github/workflows/backend-dev-preview.yml b/.github/workflows/backend-dev-preview.yml
@@ -0,0 +1,24 @@
+name: Backend - Deploy (Development Preview)
+env:
+  VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+  VERCEL_PROJECT_ID: ${{ secrets.VERCEL_BACKEND_DEV_ID }}
+on:
+  push:
+    paths:
+      - 'backend/**'
+
+jobs:
+  Deploy-Development-Preview:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Vercel CLI
+        run: npm install --global vercel@canary
+      - name: Pull Vercel Environment Information
+        run: vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }}
+      - name: Build Javascript Files
+        run: npm run build
+      - name: Build Project Artifacts
+        run: vercel build --token=${{ secrets.VERCEL_TOKEN }}
+      - name: Deploy Project Artifacts to Vercel
+        run: vercel deploy --prebuilt --token=${{ secrets.VERCEL_TOKEN }}
diff --git a/.github/workflows/backend-dev.yml b/.github/workflows/backend-dev.yml
@@ -0,0 +1,26 @@
+name: Backend - Deploy (Development)
+env:
+  VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+  VERCEL_PROJECT_ID: ${{ secrets.VERCEL_BACKEND_DEV_ID }}
+on:
+  push:
+    branches:
+      - dev
+    paths:
+      - 'backend/**'
+
+jobs:
+  Deploy-Development:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Vercel CLI
+        run: npm install --global vercel@canary
+      - name: Pull Vercel Environment Information
+        run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}
+      - name: Build Javascript Files
+        run: npm run build
+      - name: Build Project Artifacts
+        run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
+      - name: Deploy Project Artifacts to Vercel
+        run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}
diff --git a/.github/workflows/backend-prod.yml b/.github/workflows/backend-prod.yml
@@ -0,0 +1,26 @@
+name: Backend - Deploy (Production)
+env:
+  VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+  VERCEL_PROJECT_ID: ${{ secrets.VERCEL_BACKEND_DEV_ID }}
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'backend/**'
+
+jobs:
+  Deploy-Production:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Vercel CLI
+        run: npm install --global vercel@canary
+      - name: Pull Vercel Environment Information
+        run: vercel pull --yes --environment=production --token=${{ secrets.VERCEL_TOKEN }}
+      - name: Build Javascript Files
+        run: npm run build
+      - name: Build Project Artifacts
+        run: vercel build --prod --token=${{ secrets.VERCEL_TOKEN }}
+      - name: Deploy Project Artifacts to Vercel
+        run: vercel deploy --prebuilt --prod --token=${{ secrets.VERCEL_TOKEN }}
diff --git a/.github/workflows/types-publish.yml b/.github/workflows/types-publish.yml
@@ -0,0 +1,24 @@
+name: Types - Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'types/**'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install Dependencies
+        run: npm ci
+      - name: Build package artifacts
+        run: npm run build
+      - name: Publish to npm
+        run: npm publish --access public
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,7 @@
 .idea
+*/.env.*
 */.env
+!*/.env.example
 */node_modules
 
 ### JetBrains ###
@@ -138,7 +140,7 @@ yarn-error.log*
 .pnpm-debug.log*
 
 # local env files
-.env*.local
+*/.env.*
 
 # vercel
 .vercel

diff --git a/aapc-backend/.gitignore → backend/.gitignore b/aapc-backend/.gitignore → backend/.gitignore
@@ -19,3 +19,4 @@
 # typescript
 *.tsbuildinfo
 next-env.d.ts
+.vercel
diff --git a/backend/.vercelignore b/backend/.vercelignore
@@ -0,0 +1 @@
+.env.*
diff --git a/aapc-backend/README.md → backend/README.md b/aapc-backend/README.md → backend/README.md
diff --git a/aapc-backend/package-lock.json → backend/package-lock.json b/aapc-backend/package-lock.json → backend/package-lock.json
diff --git a/aapc-backend/package.json → backend/package.json b/aapc-backend/package.json → backend/package.json
@@ -4,19 +4,21 @@
   "private": true,
   "description": "The backend of the AAPC website.",
   "scripts": {
-    "dev": "nodemon -x tsx src/index.ts",
+    "dev": "nodemon -x tsx ./src/index.ts",
     "build": "tsc --build",
-    "start": "tsc --build && node ./dist/index.js"
+    "start": "node ./dist/index.js",
+    "deploy:development": "npm run build && vercel build && vercel deploy --prebuilt",
+    "deploy:production": "npm run build && vercel build --prod && vercel --prod deploy --prebuilt"
   },
   "dependencies": {
+    "@aapc/types": "^0.2.0",
     "dotenv": "^16.4.5",
     "express": "^4.19.2",
     "mongodb": "^6.5.0"
   },
   "devDependencies": {
     "@types/express": "^4.17.21",
     "@types/node": "^20.12.2",
-    "aapc-types": "file:../aapc-types",
     "nodemon": "^3.1.0",
     "tsx": "^4.7.1",
     "typescript": "^5.4.3"

diff --git a/aapc-backend/src/config/mongo.config.ts → backend/src/config/mongo.config.ts b/aapc-backend/src/config/mongo.config.ts → backend/src/config/mongo.config.ts
diff --git a/...ackend/src/controllers/news.controller.ts → backend/src/controllers/news.controller.ts b/...ackend/src/controllers/news.controller.ts → backend/src/controllers/news.controller.ts
diff --git a/...nd/src/controllers/research.controller.ts → ...nd/src/controllers/research.controller.ts b/...nd/src/controllers/research.controller.ts → ...nd/src/controllers/research.controller.ts
diff --git a/aapc-backend/src/index.ts → backend/src/index.ts b/aapc-backend/src/index.ts → backend/src/index.ts
diff --git a/aapc-backend/src/repositories/IRepository.ts → backend/src/repositories/IRepository.ts b/aapc-backend/src/repositories/IRepository.ts → backend/src/repositories/IRepository.ts
@@ -1,4 +1,4 @@
-import { Article, User } from "aapc-types";
+import { Article, User } from "@aapc/types";
 import { Nullable } from "../util/types";
 
 export default interface IRepository {

diff --git a/...c/repositories/memory/MemoryRepository.ts → ...c/repositories/memory/MemoryRepository.ts b/...c/repositories/memory/MemoryRepository.ts → ...c/repositories/memory/MemoryRepository.ts
@@ -1,9 +1,8 @@
-import { Article, User } from "aapc-types";
+import { Article, User, IArticle } from "@aapc/types";
 import IRepository from "../IRepository";
 import users from "./data/users.json"
 import news from "./data/news.json"
 import researches from "./data/researches.json"
-import { IArticle } from "aapc-types/src/Article";
 import { Nullable } from "../../util/types";
 
 export default class MemoryRepository implements IRepository {

diff --git a/...nd/src/repositories/memory/data/news.json → ...nd/src/repositories/memory/data/news.json b/...nd/src/repositories/memory/data/news.json → ...nd/src/repositories/memory/data/news.json
diff --git a/.../repositories/memory/data/researches.json → .../repositories/memory/data/researches.json b/.../repositories/memory/data/researches.json → .../repositories/memory/data/researches.json
diff --git a/...d/src/repositories/memory/data/users.json → ...d/src/repositories/memory/data/users.json b/...d/src/repositories/memory/data/users.json → ...d/src/repositories/memory/data/users.json
diff --git a/aapc-backend/src/repositories/repository.ts → backend/src/repositories/repository.ts b/aapc-backend/src/repositories/repository.ts → backend/src/repositories/repository.ts
diff --git a/aapc-backend/src/routes/news.router.ts → backend/src/routes/news.router.ts b/aapc-backend/src/routes/news.router.ts → backend/src/routes/news.router.ts
diff --git a/aapc-backend/src/routes/research.router.ts → backend/src/routes/research.router.ts b/aapc-backend/src/routes/research.router.ts → backend/src/routes/research.router.ts
diff --git a/aapc-backend/src/util/types.ts → backend/src/util/types.ts b/aapc-backend/src/util/types.ts → backend/src/util/types.ts
diff --git a/aapc-backend/tsconfig.json → backend/tsconfig.json b/aapc-backend/tsconfig.json → backend/tsconfig.json
diff --git a/backend/vercel.json b/backend/vercel.json
@@ -0,0 +1,14 @@
+{
+  "builds": [
+    {
+      "src": "dist/index.js",
+      "use": "@vercel/node"
+    }
+  ],
+  "rewrites": [
+    {
+      "source": "/(.*)",
+      "destination": "dist/index.js"
+    }
+  ]
+}
diff --git a/aapc-frontend/.eslintrc.json → frontend/.eslintrc.json b/aapc-frontend/.eslintrc.json → frontend/.eslintrc.json
diff --git a/aapc-frontend/.gitignore → frontend/.gitignore b/aapc-frontend/.gitignore → frontend/.gitignore
diff --git a/aapc-frontend/README.md → frontend/README.md b/aapc-frontend/README.md → frontend/README.md
diff --git a/aapc-frontend/app/(cms)/layout.tsx → frontend/app/(cms)/layout.tsx b/aapc-frontend/app/(cms)/layout.tsx → frontend/app/(cms)/layout.tsx
diff --git a/...rontend/app/(cms)/news/[id]/edit/page.tsx → frontend/app/(cms)/news/[id]/edit/page.tsx b/...rontend/app/(cms)/news/[id]/edit/page.tsx → frontend/app/(cms)/news/[id]/edit/page.tsx
diff --git a/aapc-frontend/app/(cms)/news/create/page.tsx → frontend/app/(cms)/news/create/page.tsx b/aapc-frontend/app/(cms)/news/create/page.tsx → frontend/app/(cms)/news/create/page.tsx
diff --git a/...end/app/(cms)/research/[id]/edit/page.tsx → ...end/app/(cms)/research/[id]/edit/page.tsx b/...end/app/(cms)/research/[id]/edit/page.tsx → ...end/app/(cms)/research/[id]/edit/page.tsx
diff --git a/...ontend/app/(cms)/research/create/page.tsx → frontend/app/(cms)/research/create/page.tsx b/...ontend/app/(cms)/research/create/page.tsx → frontend/app/(cms)/research/create/page.tsx
diff --git a/aapc-frontend/app/(content)/about/page.tsx → frontend/app/(content)/about/page.tsx b/aapc-frontend/app/(content)/about/page.tsx → frontend/app/(content)/about/page.tsx
diff --git a/aapc-frontend/app/(content)/layout.tsx → frontend/app/(content)/layout.tsx b/aapc-frontend/app/(content)/layout.tsx → frontend/app/(content)/layout.tsx
diff --git a/...frontend/app/(content)/news/[id]/page.tsx → frontend/app/(content)/news/[id]/page.tsx b/...frontend/app/(content)/news/[id]/page.tsx → frontend/app/(content)/news/[id]/page.tsx
diff --git a/...tend/app/(content)/research/[id]/page.tsx → ...tend/app/(content)/research/[id]/page.tsx b/...tend/app/(content)/research/[id]/page.tsx → ...tend/app/(content)/research/[id]/page.tsx
diff --git a/aapc-frontend/app/(homepage)/layout.tsx → frontend/app/(homepage)/layout.tsx b/aapc-frontend/app/(homepage)/layout.tsx → frontend/app/(homepage)/layout.tsx
diff --git a/aapc-frontend/app/(homepage)/page.tsx → frontend/app/(homepage)/page.tsx b/aapc-frontend/app/(homepage)/page.tsx → frontend/app/(homepage)/page.tsx
diff --git a/aapc-frontend/app/components/nav.tsx → frontend/app/components/nav.tsx b/aapc-frontend/app/components/nav.tsx → frontend/app/components/nav.tsx
diff --git a/aapc-frontend/app/globals.css → frontend/app/globals.css b/aapc-frontend/app/globals.css → frontend/app/globals.css
diff --git a/aapc-frontend/app/layout.tsx → frontend/app/layout.tsx b/aapc-frontend/app/layout.tsx → frontend/app/layout.tsx
diff --git a/aapc-frontend/next.config.mjs → frontend/next.config.mjs b/aapc-frontend/next.config.mjs → frontend/next.config.mjs
diff --git a/aapc-frontend/package-lock.json → frontend/package-lock.json b/aapc-frontend/package-lock.json → frontend/package-lock.json
diff --git a/aapc-frontend/package.json → frontend/package.json b/aapc-frontend/package.json → frontend/package.json
diff --git a/aapc-frontend/postcss.config.js → frontend/postcss.config.js b/aapc-frontend/postcss.config.js → frontend/postcss.config.js
diff --git a/aapc-frontend/tailwind.config.ts → frontend/tailwind.config.ts b/aapc-frontend/tailwind.config.ts → frontend/tailwind.config.ts
diff --git a/aapc-frontend/tsconfig.json → frontend/tsconfig.json b/aapc-frontend/tsconfig.json → frontend/tsconfig.json
diff --git a/aapc-types/.gitignore → types/.gitignore b/aapc-types/.gitignore → types/.gitignore
diff --git a/aapc-types/dist/main.d.mts → types/dist/main.d.mts b/aapc-types/dist/main.d.mts → types/dist/main.d.mts
diff --git a/aapc-types/dist/main.d.ts → types/dist/main.d.ts b/aapc-types/dist/main.d.ts → types/dist/main.d.ts
diff --git a/aapc-types/dist/main.js → types/dist/main.js b/aapc-types/dist/main.js → types/dist/main.js
diff --git a/aapc-types/dist/main.js.map → types/dist/main.js.map b/aapc-types/dist/main.js.map → types/dist/main.js.map
diff --git a/aapc-types/dist/main.mjs → types/dist/main.mjs b/aapc-types/dist/main.mjs → types/dist/main.mjs
diff --git a/aapc-types/dist/main.mjs.map → types/dist/main.mjs.map b/aapc-types/dist/main.mjs.map → types/dist/main.mjs.map
diff --git a/aapc-types/main.ts → types/main.ts b/aapc-types/main.ts → types/main.ts
diff --git a/aapc-types/package-lock.json → types/package-lock.json b/aapc-types/package-lock.json → types/package-lock.json
diff --git a/aapc-types/package.json → types/package.json b/aapc-types/package.json → types/package.json
@@ -1,7 +1,6 @@
 {
-  "name": "aapc-types",
-  "version": "0.2.0",
-  "private": true,
+  "name": "@aapc/types",
+  "version": "0.2.1",
   "description": "Types definitions for the AAPC website.",
   "main": "./dist/main.js",
   "module": "./dist/main.mjs",

diff --git a/aapc-types/src/Article.ts → types/src/Article.ts b/aapc-types/src/Article.ts → types/src/Article.ts
diff --git a/aapc-types/src/User.ts → types/src/User.ts b/aapc-types/src/User.ts → types/src/User.ts
diff --git a/aapc-types/tests/Article.test.ts → types/tests/Article.test.ts b/aapc-types/tests/Article.test.ts → types/tests/Article.test.ts
diff --git a/aapc-types/tests/User.test.ts → types/tests/User.test.ts b/aapc-types/tests/User.test.ts → types/tests/User.test.ts
diff --git a/aapc-types/tsconfig.json → types/tsconfig.json b/aapc-types/tsconfig.json → types/tsconfig.json
diff --git a/aapc-types/tsup.config.ts → types/tsup.config.ts b/aapc-types/tsup.config.ts → types/tsup.config.ts
diff --git a/aapc-types/vitest.config.ts → types/vitest.config.ts b/aapc-types/vitest.config.ts → types/vitest.config.ts