January 2025 Release (#3439)

* 20250126072410 Deleted all files in the develop branch in anticipation of merging develop-postgres into develop cleanly

* 20250126072432 Merge develop-postgres into develop

.coderabbit.yaml

@@ -13,6 +13,7 @@ reviews:
     drafts: false
     base_branches:
       - develop
+      - develop-postgres
       - main
 chat:
   auto_reply: true

.eslintignore

@@ -3,6 +3,10 @@ src/components/CheckIn/tagTemplate.ts
 package.json
 package-lock.json
 tsconfig.json
-
+fix-readme-links.js
+fix-repo-url.js
 # Ignore the Docusaurus website subdirectory
-docs/**
+docs/**
+
+#Ignore markdown files from linting
+*.md

.eslintrc.json

@@ -152,6 +152,7 @@
     "docs/docusaurus.config.ts",
     "docs/sidebars.ts",
     "docs/src/**",
-    "docs/blog/**"
+    "docs/blog/**",
+    "pyproject.toml"
   ]
 }

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+ignore = E402,E722,E203,F401,W503
+max-line-length = 80

.github/workflows/pull-request.yml

@@ -38,11 +38,12 @@ jobs:
       - name: Count number of lines
         run: |
           chmod +x ./.github/workflows/scripts/countline.py
-          ./.github/workflows/scripts/countline.py --lines 600 --exclude_files src/screens/LoginPage/LoginPage.tsx src/GraphQl/Queries/Queries.ts src/screens/OrgList/OrgList.tsx src/GraphQl/Mutations/mutations.ts src/components/EventListCard/EventListCardModals.tsx src/components/TagActions/TagActionsMocks.ts src/utils/interfaces.ts src/screens/MemberDetail/MemberDetail.tsx
+          ./.github/workflows/scripts/countline.py --lines 600 --exclude_files src/screens/LoginPage/LoginPage.tsx src/GraphQl/Queries/Queries.ts src/screens/OrgList/OrgList.tsx src/GraphQl/Mutations/mutations.ts src/components/EventListCard/EventListCardModals.tsx src/components/TagActions/TagActionsMocks.ts src/utils/interfaces.ts src/screens/MemberDetail/MemberDetail.tsx src/components/OrgPostCard/OrgPostCard.tsx src/components/UsersTableItem/UsersTableItem.tsx
 
       - name: Get changed TypeScript files
         id: changed-files
         uses: tj-actions/changed-files@v45
+
       - name: Check formatting
         if: steps.changed-files.outputs.only_changed != 'true'
         run: npm run format:check
@@ -65,9 +66,7 @@ jobs:
         run: npm run check-tsdoc # Run the TSDoc check script
 
       - name: Check for localStorage Usage
-        run: |
-          chmod +x scripts/githooks/check-localstorage-usage.js
-          node scripts/githooks/check-localstorage-usage.js --scan-entire-repo
+        run: npx tsx scripts/githooks/check-localstorage-usage.ts --scan-entire-repo
 
       - name: Compare translation files
         run: |
@@ -96,6 +95,9 @@ jobs:
         uses: tj-actions/changed-files@v45
         with:
           files: |
+            .flake8
+            .pydocstyle
+            pyproject.toml
             .env*
             vitest.config.js
             src/App.tsx
@@ -201,6 +203,7 @@ jobs:
         run: |
           python .github/workflows/scripts/eslint_disable_check.py --files ${{ steps.changed-files.outputs.all_changed_files }}
 
+
   Check-Code-Coverage-Disable:
     name: Check for code coverage disable
     runs-on: ubuntu-latest
@@ -242,27 +245,50 @@ jobs:
         uses: tj-actions/changed-files@v45
 
       - name: Run Jest Tests
-        if: steps.changed-files.outputs.only_changed != 'true'
+        if: steps.changed-files.outputs.any_changed == 'true'
         env:
           NODE_V8_COVERAGE: './coverage/jest'
         run: |
           npm run test -- --watchAll=false --coverage
 
+      - name: Upload Jest Coverage to Codecov
+        if: steps.changed-files.outputs.any_changed == 'true'
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage/jest/lcov.info
+          flags: jest
+          fail_ci_if_error: true
+
       - name: Run Vitest Tests
-        if: steps.changed-files.outputs.only_changed != 'true'
+        if: steps.changed-files.outputs.any_changed == 'true'
         env:
           NODE_V8_COVERAGE: './coverage/vitest'
         run: |
           npm run test:vitest:coverage
 
-      - name: Merge Coverage Reports
-        if: steps.changed-files.outputs.only_changed != 'true'
+      - name: Upload Vitest Coverage to Codecov
+        if: steps.changed-files.outputs.any_changed == 'true'
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage/vitest/lcov.info
+          flags: vitest
+          fail_ci_if_error: true
+
+      - name: Merge Jest and Vitest Coverage Reports
         run: |
-          mkdir -p coverage
-          if ! npx lcov-result-merger 'coverage/*/lcov.info' > 'coverage/lcov.info'; then
-            echo "Failed to merge coverage reports"
-            exit 1
-          fi     
+          mkdir -p ./coverage
+          npx lcov-result-merger './coverage/*/lcov.info' './coverage/lcov.info'
+  
+      - name: Upload Combined Coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          gcov_ignore: 'docs/'
+          files: ./coverage/lcov.info
+          flags: combined
+          fail_ci_if_error: true
 
       - name: TypeScript compilation for changed files
         run: |
@@ -272,21 +298,11 @@ jobs:
             fi
           done
 
-      - name: Present and Upload coverage to Codecov as ${{env.CODECOV_UNIQUE_NAME}}
-        uses: codecov/codecov-action@v4
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          verbose: true
-          gcov_ignore: 'docs/'
-          fail_ci_if_error: false
-          files: './coverage/lcov.info'
-          name: '${{env.CODECOV_UNIQUE_NAME}}'
-
       - name: Test acceptable level of code coverage
         uses: VeryGoodOpenSource/very_good_coverage@v3
         with:
           path: "./coverage/lcov.info"
-          min_coverage: 0.0
+          min_coverage: 0
 
   # Graphql-Inspector:
   #   if: ${{ github.actor != 'dependabot[bot]' }}
@@ -399,27 +415,30 @@ jobs:
         run: |
           docker stop talawa-admin-app-container
           docker rm talawa-admin-app-container
+  
 
   Test-Docusaurus-Deployment:
     name: Test Deployment to https://docs-admin.talawa.io
     runs-on: ubuntu-latest
     needs: [Docker-Start-Check, Start-App-Without-Docker]
-    # Run only if the develop-postgres branch and not dependabot    
+    # Run only if the develop-postgres branch and not dependabot
     if: ${{ github.actor != 'dependabot[bot]' && github.event.pull_request.base.ref == 'develop-postgres' }}
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - name: Checkout the Repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
         with:
-          node-version: 22
-          cache: yarn
-          cache-dependency-path: 'docs/'
-      # Run Docusaurus in the ./docs directory
+          node-version: '20.x' 
+
       - name: Install dependencies
         working-directory: ./docs
-        run: yarn install --frozen-lockfile
+        run: npm install
+
       - name: Test building the website
         working-directory: ./docs
-        run: yarn build
+        run: npm run build
 
   Check-Target-Branch:
     if: ${{ github.actor != 'dependabot[bot]' }}
@@ -449,3 +468,54 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PR_NUMBER: ${{ github.event.pull_request.number }}
           GITHUB_REPOSITORY: ${{ github.repository }}
+
+
+  Python-Compliance:
+    name: Check Python Code Style
+    runs-on: ubuntu-latest
+    needs: [Code-Quality-Checks]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Cache pip packages
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python3 -m venv venv
+          source venv/bin/activate
+          python -m pip install --upgrade pip
+          pip install -r .github/workflows/requirements.txt
+
+      - name: Run Black Formatter Check
+        run: |
+          source venv/bin/activate
+          black --check .
+
+      - name: Run Flake8 Linter
+        run: |
+          source venv/bin/activate
+          flake8 --docstring-convention google --ignore E402,E722,E203,F401,W503 .github
+
+      - name: Run pydocstyle
+        run: |
+          source venv/bin/activate
+          pydocstyle --convention=google --add-ignore=D415,D205 .github
+
+      - name: Run docstring compliance check
+        run: |
+          source venv/bin/activate
+          python .github/workflows/scripts/check_docstrings.py --directories .github

.github/workflows/push-deploy-website.yml

@@ -24,7 +24,7 @@ jobs:
     name: Deploy https://docs-admin.talawa.io website
     runs-on: ubuntu-latest
     # Run only if the develop-postgres branch and not dependabot
-    if: ${{ github.actor != 'dependabot[bot]' && github.event.pull_request.base.ref == 'develop-postgres' }}
+    if: ${{ github.actor != 'dependabot[bot]' }}
     environment:
       # This "name" has to be the repos' branch that contains 
       # the current active website. There must be an entry for
@@ -38,9 +38,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: 22
-          cache: yarn
-          cache-dependency-path: 'docs/'
+          node-version: '20.x' 
       - uses: webfactory/[email protected]
         with:
           ssh-private-key: ${{ secrets.DEPLOY_GITHUB_PAGES }}

.github/workflows/requirements.txt

@@ -0,0 +1,14 @@
+#############################################################################
+# DO NOT DELETE
+#############################################################################
+#
+# Required for GitHub Action workflow python checks
+#
+#############################################################################
+#############################################################################
+
+black
+pydocstyle 
+flake8
+flake8-docstrings
+docstring_parser