Version 4 0

.backportrc.json

@@ -1,15 +1,14 @@
 {
-    "repoOwner": "spectrocloud",
-    "repoName": "librarium",
-    "editor": "code",
-
-
-    "targetBranchChoices": ["master", "version-4-0", "version-3-4", "version-3-3"],
-
-    "autoMerge": true,
-    "autoMergeMethod": "squash",
-
-    "branchLabelMapping": {
-      "^backport-(.+)$": "$1"
-    }
-  }
+  "repoOwner": "spectrocloud",
+  "repoName": "librarium",
+  "editor": "code",
+
+  "targetBranchChoices": ["master", "version-4-0", "version-3-4"],
+
+  "autoMerge": true,
+  "autoMergeMethod": "squash",
+
+  "branchLabelMapping": {
+    "^backport-(.+)$": "$1"
+  }
+}

.dockerignore

@@ -3,4 +3,5 @@ README.md
 CHANGES
 .gitignore
 .cache
-prow/
+prow/
+.env

.eslintignore

@@ -0,0 +1,25 @@
+build
+node_modules
+src/deprecated
+
+.docusaurus
+sidebar.js
+docusaurus.config.js
+*.config.js
+
+# swizzled components
+src/theme/SchemaItem/index.js
+src/theme/CodeBlock/**
+DocSidebarItem
+
+#test files
+
+*.test.tsx
+*.test.ts
+
+*.test.js
+*.test.jsx
+
+__mocks__
+
+jest.setup.ts

.eslintrc.js

@@ -0,0 +1,50 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2015: true,
+    node: true,
+  },
+  settings: {
+    "import/resolver": "webpack",
+  },
+  extends: ["eslint:recommended", "plugin:react/recommended", "prettier"],
+  overrides: [
+    {
+      files: ["./**/*.{ts,tsx}"],
+      env: { browser: true, es6: true, node: true },
+      extends: [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended-type-checked",
+      ],
+      parser: "@typescript-eslint/parser",
+      parserOptions: {
+        ecmaFeatures: { jsx: true, experimentalObjectRestSpread: true },
+        ecmaVersion: 2020,
+        sourceType: "module",
+        project: "./tsconfig.eslint.json",
+      },
+      plugins: ["@typescript-eslint"],
+      rules: {
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-unsafe-assignment": "off",
+      },
+      overrides: [
+        {
+          files: ["*.js", "*.jsx"],
+          extends: ["plugin:@typescript-eslint/disable-type-checked"],
+        },
+      ],
+    },
+  ],
+  parserOptions: {
+    sourceType: "module",
+    ecmaVersion: 2020,
+  },
+  plugins: ["react"],
+  rules: {
+    "no-unused-vars": 1,
+    "react/prop-types": 0,
+  },
+};

.github/workflows/aloglia_crawler.yaml

@@ -0,0 +1,31 @@
+name: Algolia Crawler
+
+on:
+  workflow_run:
+    workflows: ["Release to Production"]
+    types: [completed]
+jobs:
+  docsearch:
+    runs-on: 
+      group: Default
+      labels: docbot
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Run scraper
+        env:
+          APPLICATION_ID: ${{ secrets.ALGOLIA_APP_ID }}
+          API_KEY: ${{ secrets.ALGOLIA_ADMIN_KEY }}
+        run: docker run  -e APPLICATION_ID=$APPLICATION_ID  -e API_KEY=$API_KEY  -e "CONFIG=$(cat ./docsearch.config.json | jq -r tostring)" algolia/docsearch-scraper
+
+      - name: Slack Notification
+        if: ${{ failure() }}
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+          SLACK_USERNAME: "spectromate"
+          SLACK_ICON_EMOJI: ":robot_panic:"
+          SLACK_COLOR: ${{ job.status }}
+          SLACK_MESSAGE: 'The Docs Algolia crawler job failed. Please check the GitHub Actions logs for more details.'

.github/workflows/backport.yaml

@@ -16,18 +16,40 @@ jobs:
         || (github.event.action == 'closed')
       )
     steps:
+
+      - name: Retrieve Credentials
+        id: import-secrets
+        uses: hashicorp/[email protected]
+        with:
+          url: https://vault.prism.spectrocloud.com
+          method: approle
+          roleId: ${{ secrets.VAULT_ROLE_ID }}
+          secretId: ${{ secrets.VAULT_SECRET_ID }}
+          secrets: /providers/github/organizations/spectrocloud/token?org_name=spectrocloud token | VAULT_GITHUB_TOKEN
+
       - name: Backport Action
-        uses: sqren/backport-github-action@v8.9.3
+        uses: sqren/backport-github-action@v9.3.0-a
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
+        # We are using a PAT token through our Vault Operator to address the issue of PRs workflows not being triggered
+        # Refer to issue https://github.com/sqren/backport-github-action/issues/79 for more details.
+          github_token: ${{ steps.import-secrets.outputs.VAULT_GITHUB_TOKEN }}
           auto_backport_label_prefix: backport-
           add_original_reviewers: true
 
       - name: Info log
         if: ${{ success() }}
         run: cat ~/.backport/backport.info.log
-        
+
       - name: Debug log
         if: ${{ failure() }}
-        run: cat ~/.backport/backport.debug.log        
-
+        run: cat ~/.backport/backport.debug.log
+
+      - name: Slack Notification
+        if: ${{ failure() }}
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+          SLACK_USERNAME: "spectromate"
+          SLACK_ICON_EMOJI: ":robot_panic:"
+          SLACK_COLOR: ${{ job.status }}
+          SLACK_MESSAGE: 'The backport automation flow failed. Review the GitHub Actions logs for more details.'

.github/workflows/eslint-test.yaml

@@ -0,0 +1,47 @@
+name: Eslint and Test cases
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    paths:
+      - "src/**"
+
+concurrency:
+  group: test-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  run-ci:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash
+    if: ${{ !github.event.pull_request.draft }}
+    steps:
+      - run: exit 0
+
+  build:
+    name: Build
+    needs: [run-ci]
+    runs-on: 
+      group: Default
+      labels: docbot
+    if: ${{ !github.event.pull_request.draft }}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v3
+        with:
+          node-version: "18"
+          cache: "npm"
+
+      - run: npm ci
+
+      - name: Eslint
+        run: |
+          npm run lint
+      - name: Test
+        run: |
+          npm run test

.github/workflows/gitleaks.yaml

@@ -30,6 +30,6 @@ jobs:
           if [ "$total_failed_tests" -gt 0 ]; then
             echo "GitLeaks validation check failed with above findings..."
             exit 1
-          else 
+          else
             echo "GitLeaks validation check passed"
-          fi
+          fi

.github/workflows/image_optimizer.yaml

@@ -3,10 +3,10 @@ name: image_optimizer
 on:
   pull_request:
     paths:
-      - '**.jpg'
-      - '**.jpeg'
-      - '**.png'
-      - '**.webp'
+      - "**.jpg"
+      - "**.jpeg"
+      - "**.png"
+      - "**.webp"
 
 concurrency:
   group: image-${{ github.ref }}
@@ -20,15 +20,17 @@ jobs:
         shell: bash
     if: ${{ !github.event.pull_request.draft }}
     steps:
-    # If the condition above is not met, aka, the PR is not in draft status, then this step is skipped.
-    # Because this step is part of the critical path, omission of this step will result in remaining CI steps not gettinge executed.
-    # As of 8/8/2022 there is now way to enforce this beahvior in GitHub Actions CI.
+      # If the condition above is not met, aka, the PR is not in draft status, then this step is skipped.
+      # Because this step is part of the critical path, omission of this step will result in remaining CI steps not gettinge executed.
+      # As of 8/8/2022 there is now way to enforce this beahvior in GitHub Actions CI.
       - run: exit 0
 
   image-optimizer:
     name: Image Optimization
     needs: [run-ci]
-    runs-on: ubuntu-latest
+    runs-on: 
+      group: Default
+      labels: docbot
     if: ${{ !github.event.pull_request.draft }}
     steps:
       - name: Checkout Repository
@@ -38,4 +40,4 @@ jobs:
         uses: calibreapp/image-actions@main
         with:
           githubToken: ${{ secrets.GITHUB_TOKEN }}
-          ignorePaths: 'node_modules/**,build'
+          ignorePaths: "node_modules/**,build"