Merge branch 'development'

Author: tjtanjin

.env.template

@@ -0,0 +1,2 @@
+# add the project root here
+PUBLIC_SITE_ROOT=http://localhost:3000

.github/workflows/ci-cd-pipeline.yml

@@ -43,4 +43,5 @@ jobs:
     secrets: inherit
     with:
       target_env: ${{ github.ref == 'refs/heads/master' && 'production' || github.ref == 'refs/heads/development' && 'development' || 'invalid' }}
-      node-version: "22.4.1"
+      node-version: "22.4.1"
+      skip_deploy: ${{ github.event_name == 'pull_request' }} # skip deployment if it's a pull request

.github/workflows/deploy.yml

@@ -38,16 +38,6 @@ jobs:
           name: ${{ vars.PROJECT_NAME }}
           path: ${{ vars.PROJECT_NAME }}
 
-      # temp: for debugging
-      - name: List files after artifact download
-        run: |
-          echo ">>> Listing the top-level workspace directories:"
-          ls -la
-          echo ">>> Listing contents of ${{ vars.PROJECT_NAME }} (artifact folder):"
-          ls -la ${{ vars.PROJECT_NAME }}
-          echo ">>> Full recursive tree of ${{ vars.PROJECT_NAME }}:"
-          ls -R ${{ vars.PROJECT_NAME }}
-
       - name: Deploy files to VPS
         # Clears existing files and deploy new files
         run: |

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

@@ -16,6 +16,10 @@ on:
         description: 'The deployment environment e.g. production or development'
         required: true
         type: string
+      skip_deploy:
+        description: 'Skip the deploy step (true/false)'
+        required: true
+        type: boolean
 
 jobs:
   lint:
@@ -52,6 +56,9 @@ jobs:
       - name: Checkout code
         # Checks out the repository code.
         uses: actions/checkout@v4
+
+      - name: Load env file
+        run: echo "${{ secrets.APPLICATION_ENV_FILE }}" > .env
 
       - name: Setup Node.js ${{ inputs.node-version }}
         # Sets up NodeJS environment
@@ -78,6 +85,7 @@ jobs:
   trigger-deploy:
     needs: build
     name: Deploy
+    if: ${{ inputs.skip_deploy == false }}
     uses: ./.github/workflows/deploy.yml
     secrets: inherit
     with:

.gitignore

@@ -6,16 +6,17 @@
 # development files
 .docusaurus/
 
+# env
+.env
+.env.*
+!.env.template
+
 # production
 /build
 *.tgz
 
 # misc
 .DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
 
 npm-debug.log*
 yarn-debug.log*

docusaurus.config.js

@@ -1,6 +1,7 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
 
+require('dotenv').config();
 const {themes} = require('prism-react-renderer');
 const lightCodeTheme = themes.github;
 const darkCodeTheme = themes.dracula;
@@ -38,7 +39,7 @@ const config = {
   favicon: 'img/favicon.ico',
 
   // Set the production url of your site here
-  url: 'https://react-chatbotify.com',
+  url: process.env.PUBLIC_SITE_ROOT || 'http://localhost:3000',
   // Set the /<baseUrl>/ pathname under which your site is served
   // For GitHub pages deployment, it is often '/<projectName>/'
   baseUrl: '/',
@@ -89,6 +90,7 @@ const config = {
         logo: {
           alt: 'React ChatBotify Logo',
           src: 'img/react-chatbotify.png',
+          href: process.env.PUBLIC_SITE_ROOT || '/',
         },
         items: [
           {

package-lock.json

@@ -38,6 +38,7 @@
     "@docusaurus/module-type-aliases": "^3.2.0",
     "@tsconfig/docusaurus": "^2.0.2",
     "@typescript-eslint/eslint-plugin": "^5.60.1",
+    "dotenv": "^16.5.0",
     "eslint": "^8.43.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jsx-a11y": "^6.7.1",