Merge remote-tracking branch 'upstream/develop' into develop

.env.example

@@ -17,4 +17,7 @@ REACT_APP_USE_RECAPTCHA=
 # from here for reCAPTCHA v2 and "I'm not a robot" Checkbox, and paste the key here.
 # Note: In domains, fill localhost 
 
-REACT_APP_RECAPTCHA_SITE_KEY=
+REACT_APP_RECAPTCHA_SITE_KEY=
+
+# has to be inserted in the env file to use plugins and other websocket based features.
+REACT_APP_BACKEND_WEBSOCKET_URL=ws://localhost:4000/graphql

.eslintignore

@@ -0,0 +1,2 @@
+# Contains the PDF file of the Tag as JSON string, thus does not need to be linted
+src/components/CheckIn/tagTemplate.ts

.eslintrc.json

@@ -27,7 +27,7 @@
   },
 
   // Specify the ESLint plugins tobe used
-  "plugins": ["react", "@typescript-eslint", "react-hooks", "jest"],
+  "plugins": ["react", "@typescript-eslint", "jest"],
   "rules": {
     "react/destructuring-assignment": ["off"],
     "@typescript-eslint/no-explicit-any": ["off"],
@@ -44,6 +44,59 @@
         "extensions": [".tsx"]
       }
     ],
+    "@typescript-eslint/ban-types": "error",
+    "@typescript-eslint/no-duplicate-enum-values": "error",
+    "@typescript-eslint/array-type": "error",
+    "@typescript-eslint/consistent-type-assertions": "error",
+    "@typescript-eslint/consistent-type-imports": "error",
+    "@typescript-eslint/explicit-function-return-type": [
+      2,
+      {
+        "allowExpressions": true,
+        "allowTypedFunctionExpressions": true
+      }
+    ],
+    "@typescript-eslint/naming-convention": [
+      "error",
+      // Interfaces must begin with Interface or TestInterface followed by a PascalCase name
+      {
+        "selector": "interface",
+        "format": ["PascalCase"],
+        "prefix": ["Interface", "TestInterface"]
+      },
+      // Type Aliases must be in PascalCase
+      {
+        "selector": ["typeAlias", "typeLike", "enum"],
+        "format": ["PascalCase"]
+      },
+      {
+        "selector": "typeParameter",
+        "format": ["PascalCase"],
+        "prefix": ["T"]
+      },
+      {
+        "selector": "variable",
+        "format": ["camelCase", "UPPER_CASE"],
+        "leadingUnderscore": "allow"
+      },
+      {
+        "selector": "parameter",
+        "format": ["camelCase"],
+        "leadingUnderscore": "allow"
+      },
+      {
+        "selector": "function",
+        "format": ["camelCase"]
+      },
+      {
+        "selector": "memberLike",
+        "modifiers": ["private"],
+        "format": ["camelCase"],
+        "leadingUnderscore": "require"
+      },
+
+      { "selector": "variable", "modifiers": ["exported"], "format": null }
+    ],
     // Ensures that components are always written in PascalCase
     "react/jsx-pascal-case": [
       "error",

.github/dependabot.yaml

@@ -0,0 +1,18 @@
+# Configuration for automated dependency updates using Dependabot
+version: 2
+updates:
+  # Define the target package ecosystem
+  - package-ecosystem: "npm"
+    # Specify the root directory
+    directory: "/"
+    # Schedule automated updates to run weekly
+    schedule:
+      interval: "weekly"
+    # Labels to apply to Dependabot PRs
+    labels:
+      - "dependencies"
+    # Specify the target branch for PRs
+    target-branch: "develop"
+    # Customize commit message prefix
+    commit-message:
+      prefix: "chore(deps):"

.github/pull_request_template.md

@@ -4,9 +4,11 @@ This section can be deleted after reading.
 We employ the following branching strategy to simplify the development process and to ensure that only stable code is pushed to the `master` branch:
 
 - `develop`: For unstable code: New features and bug fixes.
-- `alpha-x.x.x`: For stability testing: Only bug fixes accepted.
 - `master`: Where the stable production ready code lies. Only security related bugs.
 
+NOTE!!!
+
+ONLY SUBMIT PRS AGAINST OUR `DEVELOP` BRANCH. THE DEFAULT IS `MAIN`, SO YOU WILL HAVE TO MODIFY THIS BEFORE SUBMITTING YOUR PR FOR REVIEW. PRS MADE AGAINST `MAIN` WILL BE CLOSED.
 -->
 
 <!--

.github/workflows/issue.yml

@@ -18,7 +18,7 @@ jobs:
     name: Adding Issue Label
     runs-on: ubuntu-latest
     steps:
-      - uses: Renato66/auto-label@v2.2.0
+      - uses: Renato66/auto-label@v2.3.0
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           ignore-comments: true

.github/workflows/pull-requests.yml

@@ -28,7 +28,22 @@ jobs:
       - name: Checkout the Repository
         uses: actions/checkout@v3
 
-      - name: Install Dependencies
+      - name: Restore node_modules from cache
+        id: cache-npm
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-node-modules
+        with:
+          path: |
+            ~/.npm
+            node_modules
+          key: ${{ runner.os }}-generate-docs-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-generate-docs-${{ env.cache-name }}-
+            ${{ runner.os }}-generate-docs-
+            ${{ runner.os }}-
+
+      - name: Install dependencies
         run: npm install --legacy-peer-deps
 
       - name: Run linting check
@@ -59,4 +74,24 @@ jobs:
         uses: VeryGoodOpenSource/very_good_coverage@v2
         with:
           path: "./coverage/lcov.info"
-          min_coverage: 91.0
+          min_coverage: 95.0
+  Graphql-Inspector:
+    name: Runs Introspection on the github talawa-api repo on the schema.graphql file
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the Repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '16.14.1'
+
+      - name: Resolve dependency
+        run: npm install -g @graphql-inspector/cli
+
+      - name: Clone API repository
+        run: git clone https://github.com/PalisadoesFoundation/talawa-api && ls -a
+
+      - name: Validate Documents
+        run: graphql-inspector validate './src/GraphQl/**/*.ts' './talawa-api/schema.graphql'

.github/workflows/push.yml

@@ -19,19 +19,129 @@ on:
 env:
     CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }}
 
-jobs:      
+jobs:
   Code-Coverage:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - run: npm install --legacy-peer-deps
+
+      - name: Cache node modules
+        id: cache-npm
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-node-modules
+        with:
+          path: |
+            ~/.npm
+            node_modules
+          key: ${{ runner.os }}-code-coverage-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-code-coverage-${{ env.cache-name }}-
+            ${{ runner.os }}-code-coverage-
+            ${{ runner.os }}-
+      
+      - if: ${{ steps.cache-npm.outputs.cache-hit != 'true' }}
+        name: List the state of node modules
+        run: npm install --legacy-peer-deps
       - run: npm run test -- --watchAll=false --coverage
       - name: Present and upload coverage to Codecov as ${{env.CODECOV_UNIQUE_NAME}}
         uses: codecov/codecov-action@v3
         with:
           verbose: true
           fail_ci_if_error: false
           name: '${{env.CODECOV_UNIQUE_NAME}}'
+
+  Generate-Documentation:
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/automated-docs'
+    steps:
+      - name: Checkout the Repository
+        uses: actions/checkout@v3
+
+      - name: Restore node_modules from cache
+        id: cache-npm
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-node-modules
+        with:
+          path: |
+            ~/.npm
+            node_modules
+          key: ${{ runner.os }}-generate-docs-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-generate-docs-${{ env.cache-name }}-
+            ${{ runner.os }}-generate-docs-
+            ${{ runner.os }}-
+
+      - name: Install dependencies
+        run: npm install --legacy-peer-deps
+
+      - name: Install TypeScript Globally and add GraphQL tag
+        run: yarn global add typescript
+      - run: yarn add graphql-tag
+
+      - name: Update Dependencies
+        run: yarn upgrade
+
+      - name: Generate Documentation of Markdown pages
+        run: |
+          yarn global add typedoc
+          yarn add typedoc-plugin-markdown
+          yarn typedoc --entryPoints src/components src/screens --out talawa-admin-docs --plugin typedoc-plugin-markdown --theme markdown --entryPointStrategy expand --exclude "**/*.test.ts" --exclude "**/*.css"
+          
+      - name: Checking doc updated
+        id: DocUpdated
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "updateDoc=true" >> $GITHUB_OUTPUT
+            echo -e "Documentation has been updated!!"
+          else
+            Green='0;32'
+            NoColor='\033[0m'
+            echo -e "${Green}No documentation updated${NoColor}"
+          fi
+          
+      - name: Set env variables
+        if: steps.DocUpdated.outputs.updateDoc
+        run: |
+          echo "commit_id=$(echo $(git rev-parse HEAD))" >> $GITHUB_ENV
+          echo "email=$(echo $(git log --pretty=format:"%ae" $commit_id))" >> $GITHUB_ENV
+        
+      - name: Update Doc
+        if: steps.DocUpdated.outputs.updateDoc
+        run: |
+          Green='0;32'
+          NoColor='\033[0m' 
+          git config --global user.name "${{github.actor}}"
+          git config --global user.email "${{env.email}}"
+          git add .
+          git commit -m "Update documentation"
+          git push
+          echo -e "🚀${Green} Hurrah! doc updated${NoColor}"
+      
+      - name: Create Documentation Artifact
+        uses: actions/upload-artifact@v2
+        with:
+          name: documentation-admin
+          path: talawa-admin-docs
+
+  Copy-docs-to-talawa-docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: dmnemec/copy_file_to_another_repo_action@v1.1.1
+      env:
+        API_TOKEN_GITHUB: ${{ secrets.TALAWA_DOCS_SYNC_NEW }}    
+      with:
+        source_file: 'talawa-admin-docs/'
+        destination_repo: 'PalisadoesFoundation/talawa-docs'
+        destination_branch: 'develop'
+        destination_folder: 'docs/'
+        user_email: '${{env.email}}'
+        user_name: '${{github.actor}}'
+        commit_message: 'Talawa Admin docs updated'
+
+

.github/workflows/stale.yml

@@ -25,17 +25,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/stale@v7
+    - uses: actions/stale@v8
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
-        stale-issue-message: 'This issue did not get any activity in the past 10 days and will be closed in 365 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.'
-        stale-pr-message: 'This pull request did not get any activity in the past 10 days and will be closed in 365 days if no update occurs. Please verify it has no conflicts with the develop branch and rebase if needed. Mention it now if you need help or give permission to other people to finish your work.'
-        close-issue-message: 'This issue did not get any activity in the past 365 days and thus has been closed. Please check if the newest release or develop branch has it fixed. Please, create a new issue if the issue is not fixed.'
-        close-pr-message: 'This pull request did not get any activity in the past 365 days and thus has been closed.'
+        stale-issue-message: 'This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.'
+        stale-pr-message: 'This pull request did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please verify it has no conflicts with the develop branch and rebase if needed. Mention it now if you need help or give permission to other people to finish your work.'
+        close-issue-message: 'This issue did not get any activity in the past 180 days and thus has been closed. Please check if the newest release or develop branch has it fixed. Please, create a new issue if the issue is not fixed.'
+        close-pr-message: 'This pull request did not get any activity in the past 180 days and thus has been closed.'
         stale-issue-label: 'no-issue-activity'
         stale-pr-label: 'no-pr-activity'
         days-before-stale: 10
-        days-before-close: 365
+        days-before-close: 180
         remove-stale-when-updated: true
         exempt-all-milestones: true
         exempt-pr-labels: 'wip'

.husky/pre-commit

@@ -3,4 +3,6 @@
 
 npm run format:fix
 npm run lint:fix
-npm run typecheck
+npm run typecheck
+
+git add .

.prettierignore

@@ -1,2 +1,4 @@
 node_modules
-.github
+.github
+# Contains the PDF file of the Tag as JSON string, thus does not need to be formatted
+src/components/CheckIn/tagTemplate.ts