build: add and use @ashgw/env (#421)

* build: add `ts-env` * chore: clearup constants * fix: mdx lint errors * chore: refactor the mdx service * test: build * fix: load env vars correctly * build: add dotenv in catalog * chore: remove uncessary env vars * chore: finish off `www` env setup * build: create the env package * chore: add more strictness with zod * fix: jiti not detecting global `env` package * build: add `jiti` in catalog * refactor: make the blog identical to www * chore: delete the build action * build: add husky in root * ci: improve `setup-env` action * ci: cleanup `NODE_ENV` inputs * ci: update the whole workflow * fix: env var bash script clash with GH * fix: add missing action checkout * fix: smol typo * fix: add vercel upload `.env` step * fix: remove the redundant `--yes` env push option * chore: switch `staging` with `preview` * chore: remove and add back Vercel env vars * fix: add envirnoment retries * chore: hold state * fix: with a new scheme * fix: smol bug * fix: missing yes option * chore: use `jq` instead for parsing * revert: back to old logic * chore: bug WIP * fix: use the installed Vercel version * ci: add new way to sync env vars * fix: fill in actual vars * fix: switch different layout * fix: actually correct the name spelling * fix: uncomment error var * fix: cleanup again * fix: new setup * fix: add missing shell * fix: remove all the shit mane * chore: add missing comment * fix: add `with-dotenv` * revert: add `with-dotenv` * chore: import path using ES modules * ci: add `ready-for-preview` label check * ci: add `ready-for-preview` label check for `www` * build: add `pnpm` in `engine` * build: transpile packages * feat: add `@ashgw/ts-env` as an internal package * build: run dedupe * build: make it work * fix: remove with env * fix: remove `with-env` * fix: remove the `dtoenv` CLI * fix: remove `@ashgw/ts-env` from the workspace & use the npm version * fix: remove TODOs
ashgw · Jan 16, 2025 · d39d7c5 · d39d7c5
1 parent c0baa56
commit d39d7c5
Show file tree

Hide file tree

Showing 91 changed files with 4,591 additions and 4,270 deletions.
diff --git a/.github/actions/build/action.yml b/.github/actions/build/action.yml
diff --git a/.github/actions/setup-env/action.yml b/.github/actions/setup-env/action.yml
@@ -1,17 +1,32 @@
-name: 'Setup Environment Variables'
-description: 'Sets up env from GitHub Secrets'
+name: "Setup Environment Variables"
+description: "Sets up env from GitHub Secrets"
 inputs:
-  ENV_VARS:
-    description: 'Environment variables to set up in .env.local'
+  NODE_ENV:
+    description: "either 'development', 'preview', or 'production' & defo not 'prod' or 'dev'"
     required: true
-  GA_ID:
-    description: 'Google Analytics ID to add to .env'
+  NEXT_PUBLIC_WWW_URL:
     required: true
+  NEXT_PUBLIC_BLOG_URL:
+    required: true
+  NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID:
+    required: true
+  NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID:
+    required: true
+
 runs:
   using: composite
   steps:
     - name: Set up .env
       shell: bash
       run: |
-        echo "${{ inputs.ENV_VARS }}" >> .env.local
-        echo "GA_ID='${{ inputs.GA_ID }}'" >> .env  # Store GA_ID in .env
+        declare -A env_vars=(
+          ["NODE_ENV"]="${{ inputs.NODE_ENV }}"
+          ["NEXT_PUBLIC_WWW_URL"]="${{ inputs.NEXT_PUBLIC_WWW_URL }}"
+          ["NEXT_PUBLIC_BLOG_URL"]="${{ inputs.NEXT_PUBLIC_BLOG_URL }}"
+          ["NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID"]="${{ inputs.NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID }}"
+          ["NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID"]="${{ inputs.NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID }}"
+        )
+
+        for key in "${!env_vars[@]}"; do
+          echo "${key}='${env_vars[$key]}'" >> .env
+        done
diff --git a/.github/actions/vercel-build/action.yml b/.github/actions/vercel-build/action.yml
@@ -6,6 +6,9 @@ inputs:
   project_name:
     description: "The working directory/project name you're trying to build. Example: 'www', 'blog'"
     required: true
+  NODE_ENV:
+    description: ""
+    required: true
   VERCEL_TOKEN:
     description: "Vercel token for authentication"
     required: true
@@ -15,11 +18,17 @@ inputs:
   VERCEL_PROJECT_ID:
     description: "Vercel project ID"
     required: true
-  ENV_VARS:
-    description: "env vars"
+  NEXT_PUBLIC_WWW_URL:
+    description: ""
+    required: true
+  NEXT_PUBLIC_BLOG_URL:
+    description: ""
     required: true
-  GA_ID:
-    description: "Google Analytics"
+  NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID:
+    description: ""
+    required: true
+  NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID:
+    description: ""
     required: true
 
 runs:
@@ -29,8 +38,12 @@ runs:
     - uses: ./.github/actions/pnpm-install
     - uses: ./.github/actions/setup-env
       with:
-        ENV_VARS: ${{ inputs.ENV_VARS }}
-        GA_ID: ${{ inputs.GA_ID }}
+        NODE_ENV: ${{ inputs.NODE_ENV }}
+        NEXT_PUBLIC_WWW_URL: ${{ inputs.NEXT_PUBLIC_WWW_URL }}
+        NEXT_PUBLIC_BLOG_URL: ${{ inputs.NEXT_PUBLIC_BLOG_URL }}
+        NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID: ${{ inputs.NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID }}
+        NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID: ${{ inputs.NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID }}
+
     - name: Build for Vercel
       shell: bash
       env:

diff --git a/.github/actions/vercel-deploy/action.yml b/.github/actions/vercel-deploy/action.yml
@@ -6,14 +6,14 @@ inputs:
   project_name:
     description: "The working directory/project name you're trying to deploy. Example: 'www', 'blog'"
     required: true
-  deployment_type:
-    description: "Whether it's 'production' or 'preview'"
+  NODE_ENV:
+    description: "Vercel takes care of this"
     required: true
   VERCEL_TOKEN:
     description: "Vercel token for authentication"
     required: true
   GITHUB_TOKEN:
-    description: "GitHub token"
+    description: "GitHub toaken"
     required: true
 
 runs:
@@ -22,7 +22,7 @@ runs:
     - name: Deploy to Vercel
       shell: bash
       run: |
-        if [ "${{ inputs.deployment_type }}" == "preview" ]; then
+        if [ "${{ inputs.NODE_ENV }}" == "preview" ]; then
           cd apps/${{ inputs.project_name }} && \
           PREVIEW_URL=$(pnpm --filter @ashgw/${{ inputs.project_name }} deploy:vercel-preview --token=${{ inputs.VERCEL_TOKEN }} | grep -Eo 'https?://[^ ]+')
           echo "PREVIEW_URL=$PREVIEW_URL" >> $GITHUB_ENV
@@ -32,7 +32,7 @@ runs:
         fi
 
     - name: Notify about the deployment URL
-      if: ${{ inputs.deployment_type == 'preview' }}
+      if: ${{ inputs.NODE_ENV == 'preview' }}
       uses: actions/github-script@v6
       env:
         GITHUB_TOKEN: ${{ inputs.GITHUB_TOKEN }}

diff --git a/.github/workflows/blog-preview-deployment.yml b/.github/workflows/blog-preview-deployment.yml
@@ -10,21 +10,25 @@ permissions:
 
 jobs:
   deploy:
-    if: github.event_name == 'pull_request'
+    if: github.event_name == 'pull_request' && contains(github.event.pull_request.labels[*].name, 'ready-for-preview')
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: ./.github/actions/vercel-build
         with:
-          ENV_VARS: ${{ secrets.ENV_VARS }}
-          GA_ID: ${{ secrets.GA_ID }}
           project_name: blog
+          NODE_ENV: preview
+          NEXT_PUBLIC_WWW_URL: ${{ secrets.NEXT_PUBLIC_WWW_URL }}
+          NEXT_PUBLIC_BLOG_URL: ${{ secrets.NEXT_PUBLIC_BLOG_URL }}
+          NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID }}
+          NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID }}
           VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
           VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
-          VERCEL_PROJECT_ID: ${{ secrets.VERCEL_BLOG_PROJECT_ID }}
+          VERCEL_PROJECT_ID: ${{ secrets.VERCEL_WWW_PROJECT_ID }}
+
       - uses: ./.github/actions/vercel-deploy
         with:
-          deployment_type: preview
+          NODE_ENV: preview
           project_name: blog
           VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/blog-production-deployment.yml b/.github/workflows/blog-production-deployment.yml
@@ -15,15 +15,19 @@ jobs:
       - uses: actions/checkout@v3
       - uses: ./.github/actions/vercel-build
         with:
-          ENV_VARS: ${{ secrets.ENV_VARS }}
-          GA_ID: ${{ secrets.GA_ID }}
           project_name: blog
+          NODE_ENV: production
+          NEXT_PUBLIC_WWW_URL: ${{ secrets.NEXT_PUBLIC_WWW_URL }}
+          NEXT_PUBLIC_BLOG_URL: ${{ secrets.NEXT_PUBLIC_BLOG_URL }}
+          NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID }}
+          NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID }}
           VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
           VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
-          VERCEL_PROJECT_ID: ${{ secrets.VERCEL_BLOG_PROJECT_ID }}
+          VERCEL_PROJECT_ID: ${{ secrets.VERCEL_WWW_PROJECT_ID }}
+
       - uses: ./.github/actions/vercel-deploy
         with:
-          deployment_type: production
+          NODE_ENV: production
           project_name: blog
           VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -8,8 +8,16 @@ jobs:
   build:
     runs-on: ubuntu-20.04
     steps:
-      - uses: actions/checkout@v4
-      - uses: ./.github/actions/build
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/pnpm-install
+      - uses: ./.github/actions/setup-env
         with:
-          ENV_VARS: ${{ secrets.ENV_VARS }}
-          GA_ID: ${{ secrets.GA_ID }}
+          NODE_ENV: "production"
+          NEXT_PUBLIC_WWW_URL: ${{ secrets.NEXT_PUBLIC_WWW_URL }}
+          NEXT_PUBLIC_BLOG_URL: ${{ secrets.NEXT_PUBLIC_BLOG_URL }}
+          NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID }}
+          NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID }}
+
+      - name: build
+        shell: bash
+        run: pnpm build
diff --git a/.github/workflows/container-registry.yml b/.github/workflows/container-registry.yml
@@ -13,8 +13,11 @@ jobs:
       - uses: ./.github/actions/pnpm-install
       - uses: ./.github/actions/setup-env
         with:
-          ENV_VARS: ${{ secrets.ENV_VARS }}
-          GA_ID: ${{ secrets.GA_ID }}
+          NODE_ENV: "production"
+          NEXT_PUBLIC_WWW_URL: ${{ secrets.NEXT_PUBLIC_WWW_URL }}
+          NEXT_PUBLIC_BLOG_URL: ${{ secrets.NEXT_PUBLIC_BLOG_URL }}
+          NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID }}
+          NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID }}
       - name: Version extraction
         id: get_version
         run: echo "::set-output name=version::$(node -p "require('./package.json').version")"

diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml
@@ -12,7 +12,11 @@ jobs:
       - uses: ./.github/actions/pnpm-install
       - uses: ./.github/actions/setup-env
         with:
-          ENV_VARS: ${{ secrets.ENV_VARS }}
-          GA_ID: ${{ secrets.GA_ID }}
+          NODE_ENV: "production"
+          NEXT_PUBLIC_WWW_URL: ${{ secrets.NEXT_PUBLIC_WWW_URL }}
+          NEXT_PUBLIC_BLOG_URL: ${{ secrets.NEXT_PUBLIC_BLOG_URL }}
+          NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID }}
+          NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID }}
+
       - name: format
         run: pnpm format
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -12,8 +12,12 @@ jobs:
       - uses: ./.github/actions/pnpm-install
       - uses: ./.github/actions/setup-env
         with:
-          ENV_VARS: ${{ secrets.ENV_VARS }}
-          GA_ID: ${{ secrets.GA_ID }}
+          NODE_ENV: "production"
+          NEXT_PUBLIC_WWW_URL: ${{ secrets.NEXT_PUBLIC_WWW_URL }}
+          NEXT_PUBLIC_BLOG_URL: ${{ secrets.NEXT_PUBLIC_BLOG_URL }}
+          NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID }}
+          NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID }}
+
       - uses: ./.github/actions/pnpm-install
       - name: lint
         run: pnpm lint
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -17,8 +17,12 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - uses: ./.github/actions/setup-env
         with:
-          ENV_VARS: ${{ secrets.ENV_VARS }}
-          GA_ID: ${{ secrets.GA_ID }}
+          NODE_ENV: "development"
+          NEXT_PUBLIC_WWW_URL: ${{ secrets.NEXT_PUBLIC_WWW_URL }}
+          NEXT_PUBLIC_BLOG_URL: ${{ secrets.NEXT_PUBLIC_BLOG_URL }}
+          NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID }}
+          NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID }}
+
       - name: Running code tests
         run: pnpm test:unit-integration
 
@@ -30,8 +34,12 @@ jobs:
       - uses: ./.github/actions/pnpm-install
       - uses: ./.github/actions/setup-env
         with:
-          ENV_VARS: ${{ secrets.ENV_VARS }}
-          GA_ID: ${{ secrets.GA_ID }}
+          NODE_ENV: "development"
+          NEXT_PUBLIC_WWW_URL: ${{ secrets.NEXT_PUBLIC_WWW_URL }}
+          NEXT_PUBLIC_BLOG_URL: ${{ secrets.NEXT_PUBLIC_BLOG_URL }}
+          NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID }}
+          NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID }}
+
       - name: Install dependencies
         run: npm install -g pnpm &&  pnpm install --frozen-lockfile
       - name: Install Playwright Browsers

diff --git a/.github/workflows/www-preview-deployment.yml b/.github/workflows/www-preview-deployment.yml
@@ -10,21 +10,25 @@ permissions:
 
 jobs:
   deploy:
-    if: github.event_name == 'pull_request'
+    if: github.event_name == 'pull_request' && contains(github.event.pull_request.labels[*].name, 'ready-for-preview')
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/vercel-build
         with:
-          ENV_VARS: ${{ secrets.ENV_VARS }}
-          GA_ID: ${{ secrets.GA_ID }}
           project_name: www
+          NODE_ENV: preview
+          NEXT_PUBLIC_WWW_URL: ${{ secrets.NEXT_PUBLIC_WWW_URL }}
+          NEXT_PUBLIC_BLOG_URL: ${{ secrets.NEXT_PUBLIC_BLOG_URL }}
+          NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID }}
+          NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID }}
           VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
           VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
           VERCEL_PROJECT_ID: ${{ secrets.VERCEL_WWW_PROJECT_ID }}
+
       - uses: ./.github/actions/vercel-deploy
         with:
-          deployment_type: preview
+          NODE_ENV: preview
           project_name: www
           VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/www-production-deployment.yml b/.github/workflows/www-production-deployment.yml
@@ -15,15 +15,19 @@ jobs:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/vercel-build
         with:
-          ENV_VARS: ${{ secrets.ENV_VARS }}
-          GA_ID: ${{ secrets.GA_ID }}
           project_name: www
+          NODE_ENV: production # TODO: remove either deployment type or node env
+          NEXT_PUBLIC_WWW_URL: ${{ secrets.NEXT_PUBLIC_WWW_URL }}
+          NEXT_PUBLIC_BLOG_URL: ${{ secrets.NEXT_PUBLIC_BLOG_URL }}
+          NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_WWW_GOOGLE_ANALYTICS_ID }}
+          NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID: ${{ secrets.NEXT_PUBLIC_BLOG_GOOGLE_ANALYTICS_ID }}
           VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
           VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
           VERCEL_PROJECT_ID: ${{ secrets.VERCEL_WWW_PROJECT_ID }}
+
       - uses: ./.github/actions/vercel-deploy
         with:
-          deployment_type: production
+          NODE_ENV: production
           project_name: www
           VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.husky/pre-push b/.husky/pre-push
@@ -2,4 +2,3 @@
 . "$(dirname -- "$0")/_/husky.sh"
 # pnpm lint
 # pnpm test
-# TODO: uncomment this later
diff --git a/apps/blog/next.config.js b/apps/blog/next.config.js
@@ -3,12 +3,8 @@ import { createJiti } from "jiti";
 
 import baseConfig from "@ashgw/next-config/base.js";
 
-/* 
-  @see https://github.com/t3-oss/create-t3-turbo/blob/main/apps/nextjs/next.config.js
-  for env vars validation
-*/
-// Import env files to validate at build time. Use jiti so we can load .ts files in here.
-await createJiti(fileURLToPath(import.meta.url)).import("./src/env");
+// Import the env file to validate at build time. Use jiti so we can load .ts files in here.
+await createJiti(fileURLToPath(import.meta.url)).import("@ashgw/env");
 
 /** @type {import("next").NextConfig} */
 const config = {