refactor: enhancement and documenting

.github/workflows/build-lint-test.yaml

@@ -2,6 +2,10 @@
 
 name: Build, Lint, and Test Project
 
+# Required permission on the caller workflow
+# permissions:
+#   contents: read
+
 on:
   workflow_call:
     inputs:
@@ -11,9 +15,6 @@ on:
         default: 'lts/*'
         type: string
 
-permissions:
-  contents: read
-
 jobs:
   main:
     name: Build, Lint, and Test Project
@@ -26,7 +27,7 @@ jobs:
       - name: 🔧 Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ inputs.NODE_VERSION }}
+          node-version: ${{ inputs.node-version }}
 
       - name: 🛠️ Setup Node.js Corepack
         run: corepack enable

.github/workflows/codeql.yaml

@@ -2,14 +2,15 @@
 
 name: CodeQL
 
+# Required permission on the caller workflow
+# permissions:
+#   actions: read
+#   contents: read
+#   security-events: write
+
 on:
   workflow_call:
 
-permissions:
-  actions: read
-  contents: read
-  security-events: write
-
 jobs:
   main:
     name: CodeQL Analyze

.github/workflows/dependency-review.yaml

@@ -2,11 +2,23 @@
 
 name: Dependency Review
 
+# Required permission on the caller workflow
+# permissions:
+#   contents: read
+
 on:
   workflow_call:
-
+    inputs:
-permissions:
+      base_ref:
-  contents: read
+        description: 'The base ref for the dependency review'
+        required: false
+        type: string
+        default: 'next'
+      head_ref:
+        description: 'The head ref for the dependency review'
+        required: false
+        type: string
+        default: 'next'
 
 jobs:
   main:
@@ -19,3 +31,6 @@ jobs:
 
       - name: 🚀 Dependency Review
         uses: actions/dependency-review-action@v4
+        with:
+          base-ref: ${{ inputs.base_ref }}
+          head-ref: ${{ inputs.head_ref }}

.github/workflows/publish-npm.yaml

@@ -2,6 +2,11 @@
 
 name: Publish NPM
 
+# Required permission on the caller workflow
+# permissions:
+#   contents: read
+#   id-token: write
+
 on:
   workflow_call:
     inputs:
@@ -10,18 +15,16 @@ on:
         required: true
         default: 'lts/*'
         type: string
+      npm-registry-url:
+        description: 'NPM registry url'
+        required: false
+        default: 'https://registry.npmjs.org'
+        type: string
     secrets:
       NPM_TOKEN:
         required: true
         description: 'NPM token'
 
-env:
-  NODE_VERSION: lts/*
-
-permissions:
-  contents: read
-  id-token: write
-
 jobs:
   main:
     if: github.repository_owner == 'the-nexim'
@@ -36,7 +39,8 @@ jobs:
       - name: 🔧 Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ inputs.NODE_VERSION }}
+          node-version: ${{ inputs.node-version }}
+          registry-url: ${{ inputs.npm-registry-url }}
 
       - name: 🛠️ Setup Node.js Corepack
         run: corepack enable
@@ -60,11 +64,7 @@ jobs:
         run: yarn build
         env:
           WIREIT_LOGGER: metrics
-
+          NODE_ENV: production
-      - name: 🧹 Run ESLint
-        run: yarn lint
-        env:
-          WIREIT_LOGGER: metrics
 
       - name: 🚀 Publish
         run: yarn run publish -- --yes

.github/workflows/release.yaml

@@ -2,6 +2,10 @@
 
 name: Build & Lint & Test & Release
 
+# Required permission on the caller workflow
+# permissions:
+#   contents: write
+
 on:
   workflow_call:
     inputs:
@@ -14,16 +18,10 @@ on:
       GPG_KEY_ID:
         required: true
         description: 'GPG key ID'
-      BOT_TOKEN:
-        required: true
-        description: 'Nexim Bot token'
       GPG_PRIVATE_KEY:
         required: true
         description: 'GPG private key'
 
-permissions:
-  contents: write
-
 jobs:
   main:
     name: Build & Lint & Test & Release
@@ -34,7 +32,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          token: ${{ secrets.BOT_TOKEN }}
+          token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: 🙂‍↔️ Import GPG key
         run: |
@@ -94,5 +92,5 @@ jobs:
       - name: 🤖 Get Release
         run: yarn lerna version --yes
         env:
-          GITHUB_TOKEN: ${{ secrets.BOT_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           WIREIT_LOGGER: metrics

.github/workflows/sync-label.yaml

@@ -1,17 +1,13 @@
 # yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
-
 name: Sync labels
 
+# Required permission on the caller workflow
+# permissions:
+#   contents: read
+#   issues: write
+
 on:
   workflow_call:
-    secrets:
-      GITHUB_TOKEN:
-        description: 'GitHub token'
-        required: true
-
-permissions:
-  contents: read
-  issues: write
 
 jobs:
   main:

.vscode/settings.json

@@ -22,7 +22,10 @@
   },
   "typescript.enablePromptUseWorkspaceTsdk": true,
   "typescript.tsdk": ".yarn/sdks/typescript/lib",
-  "cSpell.words": ["nexim"],
+  "cSpell.words": [
+    "nexim",
+    "wireit"
+  ],
   "todo-tree.tree.scanMode": "workspace only",
   "github.copilot.chat.codeGeneration.instructions": [
     {