merge: updated configuration of env vars to avoid gitleaks failure (#14)

* fix: removed values from env template to avoid gitleaks failure

chore: updated readme, pr workflow and env template files

* fix: resolved cla assistant workflow issue

---------

Co-authored-by: Kabeer2004 <merchantkabeer68@gmail.com>

Author: itsskofficial

.github/workflows/cla.yaml

@@ -24,12 +24,13 @@ jobs:
           ))
         uses: contributor-assistant/github-action@v2.6.1
         env:
-          GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+
         with:
           path-to-signatures: '.github/signatures/version1/cla.json'
           path-to-document: 'https://github.com/existence-master/Sentient/blob/master/CLA.md'
           branch: 'oss'  
-          allowlist: itsskofficial,dependabot[bot]
+          allowlist: itsskofficial,Kabeer2004,dependabot[bot]
           remote-organization-name: existence-master
-          remote-repository-name: Sentient-Internal
-          force-when-sync: true
+          remote-repository-name: Sentient-Internal

.github/workflows/pr.yaml

@@ -7,9 +7,26 @@ on:
       - development
 
 jobs:
+  pre-check:
+    name: PR Base Branch Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check if PR targets master and is not from allowed users
+        run: |
+          AUTHOR="${{ github.actor }}"
+          BASE_BRANCH="${{ github.base_ref }}"
+          ALLOWED_USERS=("itsskofficial" "Kabeer2004")
+
+          if [[ "$BASE_BRANCH" == "master" && ! " ${ALLOWED_USERS[@]} " =~ " $AUTHOR " ]]; then
+            echo "PRs to master are only allowed by: ${ALLOWED_USERS[*]}"
+            exit 1
+          fi
+        shell: bash
+
   security-checks:
     name: Security & Secrets Scan
     runs-on: ubuntu-latest
+    needs: pre-check
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -27,6 +44,7 @@ jobs:
   linting:
     name: Code Linting & Formatting
     runs-on: ubuntu-latest
+    needs: pre-check
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

README.md

@@ -211,7 +211,7 @@ Install the following to start contributing to Sentient:
 <!-- Environment Variables -->
 ### 🔒: Environment Variables (Contributors)
 
-You will need the following environment variables to run the project locally. For sensitive keys like Auth0, GCP, Brave Search you can create your own accounts and populate your own keys or [contact us for our development keys.](mailto:existence.sentient@gmail.com).
+You will need the following environment variables to run the project locally. For sensitive keys like Auth0, GCP, Brave Search you can create your own accounts and populate your own keys or comment in the discussion titled ['Request Environment Variables (.env) Here'](https://github.com/existence-master/Sentient/discussions/13) if you want pre-setup keys
 
 For the Electron Frontend, you will need to create a `.env` file in the `src/interface` folder. Populate that `.env` file with the following variables (examples given).
 
@@ -252,8 +252,6 @@ For the Python Backend, you will need to create a `.env` file and place it in th
   AUTH0_DOMAIN=abcdxyz.us.auth0.com
   AUTH0_MANAGEMENT_CLIENT_ID=YOUR_MANAGEMENT_CLIENT_ID
   AUTH0_MANAGEMENT_CLIENT_SECRET=YOUR_MANAGEMENT_CLIENT_SECRET
-  AUTH0_ROLES_CLIENT_ID=ROLE_CLIENT_ID
-  AUTH0_ROLES_CLIENT_SECRET=ROLE_CLIENT_SECRET
   APP_SERVER_PORT=5000
   AGENTS_SERVER_PORT=5001
   MEMORY_SERVER_PORT=5002

src/interface/.env.template

@@ -1,9 +1,11 @@
-ELECTRON_APP_URL= http://localhost:3000
-APP_SERVER_URL= http://127.0.0.1:5000
-APP_SERVER_LOADED= false
-APP_SERVER_INITIATED= false
-NEO4J_SERVER_URL= http://localhost:7474
-NEO4J_SERVER_STARTED= false
-BASE_MODEL_REPO_ID= llama3.2:3b
-AUTH0_DOMAIN= abcdxyz.us.auth0.com
-AUTH0_CLIENT_ID= abcd1234
+# For env vars related to the Google project and Auth0 setup, comment in the discussion titled 'Request Environment Variables (.env) Here' (https://github.com/existence-master/Sentient/discussions/13) Make sure to keep the values in this file empty while committing to the repository
+
+ELECTRON_APP_URL= 
+APP_SERVER_URL= 
+APP_SERVER_LOADED=
+APP_SERVER_INITIATED=
+NEO4J_SERVER_URL=
+NEO4J_SERVER_STARTED=
+BASE_MODEL_REPO_ID=
+AUTH0_DOMAIN=
+AUTH0_CLIENT_ID=

src/model/.env.template

@@ -1,32 +1,32 @@
-NEO4J_URI=bolt://localhost:7687
-NEO4J_USERNAME=neo4j
-NEO4J_PASSWORD=abcd1234
-EMBEDDING_MODEL_REPO_ID=sentence-transformers/all-MiniLM-L6-v2
-BASE_MODEL_URL=http://localhost:11434/api/chat
-BASE_MODEL_REPO_ID=llama3.2:3b
-LINKEDIN_USERNAME=email@address.com
-LINKEDIN_PASSWORD=password123
-BRAVE_SUBSCRIPTION_TOKEN=YOUR_TOKEN_HERE
-BRAVE_BASE_URL=https://api.search.brave.com/res/v1/web/search
-GOOGLE_CLIENT_ID=YOUR_GOOGLE_CLIENT_ID_HERE
-GOOGLE_PROJECT_ID=YOUR_PROJECT_ID
-GOOGLE_AUTH_URI=https://accounts.google.com/o/oauth2/auth
-GOOGLE_TOKEN_URI=https://oauth2.googleapis.com/token
-GOOGLE_AUTH_PROVIDER_CERT_URL=https://www.googleapis.com/oauth2/v1/certs
-GOOGLE_CLIENT_SECRET=YOUR_SECRET_HERE
-GOOGLE_REDIRECT_URIS=http://localhost
-AES_SECRET_KEY=YOUR_SECRET_KEY_HERE
-AES_IV=YOUR_IV_HERE
-AUTH0_DOMAIN=abcdxyz.us.auth0.com
-AUTH0_MANAGEMENT_CLIENT_ID=YOUR_MANAGEMENT_CLIENT_ID
-AUTH0_MANAGEMENT_CLIENT_SECRET=YOUR_MANAGEMENT_CLIENT_SECRET
-AUTH0_ROLES_CLIENT_ID=ROLE_CLIENT_ID
-AUTH0_ROLES_CLIENT_SECRET=ROLE_CLIENT_SECRET
-APP_SERVER_PORT=5000
-AGENTS_SERVER_PORT=5001
-MEMORY_SERVER_PORT=5002
-CHAT_SERVER_PORT=5003
-SCRAPER_SERVER_PORT=5004
-UTILS_SERVER_PORT=5005
-COMMON_SERVER_PORT=5006
-AUTH_SERVER_PORT=5007
+# For env vars related to the Google project and Auth0 setup, comment in the discussion titled 'Request Environment Variables (.env) Here' (https://github.com/existence-master/Sentient/discussions/13) Make sure to keep the values in this file empty while committing to the repository
+
+NEO4J_URI=
+NEO4J_USERNAME=
+NEO4J_PASSWORD=
+EMBEDDING_MODEL_REPO_ID=
+BASE_MODEL_URL=
+BASE_MODEL_REPO_ID=
+LINKEDIN_USERNAME=
+LINKEDIN_PASSWORD=
+BRAVE_SUBSCRIPTION_TOKEN=
+BRAVE_BASE_URL=
+GOOGLE_CLIENT_ID=
+GOOGLE_PROJECT_ID=
+GOOGLE_AUTH_URI=
+GOOGLE_TOKEN_URI=
+GOOGLE_AUTH_PROVIDER_CERT_URL=
+GOOGLE_CLIENT_SECRET=
+GOOGLE_REDIRECT_URIS=
+AES_SECRET_KEY=
+AES_IV=
+AUTH0_DOMAIN=
+AUTH0_MANAGEMENT_CLIENT_ID=
+AUTH0_MANAGEMENT_CLIENT_SECRET=
+APP_SERVER_PORT=
+AGENTS_SERVER_PORT=
+MEMORY_SERVER_PORT=
+CHAT_SERVER_PORT=
+SCRAPER_SERVER_PORT=
+UTILS_SERVER_PORT=
+COMMON_SERVER_PORT=
+AUTH_SERVER_PORT=