Merge branch 'development' into fix/check-env-schema

.github/workflows/update-configuration.yml

@@ -0,0 +1,58 @@
+name: "Update Configuration"
+
+on:
+  workflow_dispatch:
+  push:
+
+jobs:
+  update:
+    name: "Update Configuration in manifest.json"
+    runs-on: ubuntu-latest
+    permissions: write-all
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.10.0"
+
+      - name: Install deps and run configuration update
+        run: |
+          yarn install --immutable --immutable-cache --check-cache
+          yarn tsc --noCheck --project tsconfig.json
+
+      - name: Update manifest configuration using GitHub Script
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require('fs');
+            const path = require('path');
+
+            const { pluginSettingsSchema } = require('./src/types/plugin-inputs');
+
+            const manifestPath = path.resolve("${{ github.workspace }}", './manifest.json');
+            const manifest = JSON.parse(fs.readFileSync(manifestPath, 'utf8'));
+
+            const configuration = JSON.stringify(pluginSettingsSchema);
+
+            manifest["configuration"] = JSON.parse(configuration);
+
+            const updatedManifest = JSON.stringify(manifest, null, 2)
+            console.log('Updated manifest:', updatedManifest);
+            fs.writeFileSync(manifestPath, updatedManifest);
+
+      - name: Commit and Push generated types
+        run: |
+          git config --global user.name 'ubiquity-os[bot]'
+          git config --global user.email 'ubiquity-os[bot]@users.noreply.github.com'
+          git add ./manifest.json
+          if [ -n "$(git diff-index --cached --name-only HEAD)" ]; then
+            git commit -m "chore: updated generated configuration" || echo "Lint-staged check failed"
+            git push origin HEAD:${{ github.ref_name }}
+          else
+            echo "No changes to commit"
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -42,7 +42,11 @@ Be sure to review all `*.test.*` files for implementation details.
 }
 ```
 
-Reward formula: `((count * wordValue) * (score * multiplier) * n) * relevance + task.reward = total`
+Reward formula:
+
+```math
+\sum_{i=0}^{n} \left( \sum_{j=0}^{n} \left(\text{wordCount}^{exponent} \times \text{wordValue} \times \text{relevance}\right) + \left(\text{score} \times \text{elementCount}\right) \right) \times multiplier + \text{task.reward} = \text{total}
+```
 
 ## Plugin configuration
 
@@ -80,75 +84,75 @@ with:
     dataPurge: {}
     formattingEvaluator:
       multipliers:
-          - role: [ ISSUE_SPECIFICATION ]
-            multiplier: 1
-            rewards:
-              regex:
-                "\\b\\w+\\b": 0.1
-              scores: # Scores can be set for each item differently
-                br: 0
-                code: 1
-                p: 1
-                em: 0
-                img: 0
-                strong: 0
-                blockquote: 0
-                h1: 1
-                h2: 1
-                h3: 1
-                h4: 1
-                h5: 1
-                h6: 1
-                a: 1
-                li: 1
-                ul: 1
-                td: 1
-                hr: 0
-          - role: [ISSUE_AUTHOR]
-            multiplier: 1
-            rewards:
-              regex:
-                "\\b\\w+\\b": 0.2
-          - role: [ISSUE_ASSIGNEE]
-            multiplier: 0
-            rewards:
-              regex:
-                "\\b\\w+\\b": 0
-          - role: [ISSUE_COLLABORATOR]
-            multiplier: 1
-            rewards:
-              regex:
-                "\\b\\w+\\b": 0.1
-          - role: [ISSUE_CONTRIBUTOR]
-            multiplier: 0.25
-            rewards:
-              regex:
-                "\\b\\w+\\b": 0.1
-          - role: [PULL_SPECIFICATION]
-            multiplier: 0
-            rewards:
-              regex:
-                "\\b\\w+\\b": 0
-          - role: [PULL_AUTHOR]
-            multiplier: 2
-            rewards:
-              regex:
-                "\\b\\w+\\b": 0.2
-          - role: [PULL_ASSIGNEE]
-            multiplier: 1
-            rewards:
-              regex:
-                "\\b\\w+\\b": 0.1
-          - role: [PULL_COLLABORATOR]
-            multiplier: 1
-            rewards:
-              regex:
-                "\\b\\w+\\b": 0.1
-          - role: [PULL_CONTRIBUTOR]
-            multiplier: 0.25
-            rewards:
-              regex:
-                "\\b\\w+\\b": 0.1
+        - role: [ ISSUE_SPECIFICATION ]
+          multiplier: 1
+          rewards:
+            regex:
+              "\\b\\w+\\b": 0.1
+            scores: # Scores can be set for each item differently
+              br: 0
+              code: 1
+              p: 1
+              em: 0
+              img: 0
+              strong: 0
+              blockquote: 0
+              h1: 1
+              h2: 1
+              h3: 1
+              h4: 1
+              h5: 1
+              h6: 1
+              a: 1
+              li: 1
+              ul: 1
+              td: 1
+              hr: 0
+        - role: [ISSUE_AUTHOR]
+          multiplier: 1
+          rewards:
+            regex:
+              "\\b\\w+\\b": 0.2
+        - role: [ISSUE_ASSIGNEE]
+          multiplier: 0
+          rewards:
+            regex:
+              "\\b\\w+\\b": 0
+        - role: [ISSUE_COLLABORATOR]
+          multiplier: 1
+          rewards:
+            regex:
+              "\\b\\w+\\b": 0.1
+        - role: [ISSUE_CONTRIBUTOR]
+          multiplier: 0.25
+          rewards:
+            regex:
+              "\\b\\w+\\b": 0.1
+        - role: [PULL_SPECIFICATION]
+          multiplier: 0
+          rewards:
+            regex:
+              "\\b\\w+\\b": 0
+        - role: [PULL_AUTHOR]
+          multiplier: 2
+          rewards:
+            regex:
+              "\\b\\w+\\b": 0.2
+        - role: [PULL_ASSIGNEE]
+          multiplier: 1
+          rewards:
+            regex:
+              "\\b\\w+\\b": 0.1
+        - role: [PULL_COLLABORATOR]
+          multiplier: 1
+          rewards:
+            regex:
+              "\\b\\w+\\b": 0.1
+        - role: [PULL_CONTRIBUTOR]
+          multiplier: 0.25
+          rewards:
+            regex:
+              "\\b\\w+\\b": 0.1
       permitGeneration: {}
       githubComment:
         post: true