chore: update packages; publish docs

Author: Fcmam5

.eslintrc.json

@@ -1,17 +1,17 @@
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
     branches:
       - main
       - develop
   pull_request:
-    # The branches below must be a subset of the branches above
     branches:
       - main
+      - develop
 
   schedule:
-    - cron: '0 0 * * 5'
+    - cron: '0 0 1 * *'
 
 jobs:
   analyze:
@@ -23,18 +23,17 @@ jobs:
       security-events: write
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        config-file: ./.github/codeql/codeql-configuration.yml
-  
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: javascript-typescript
+          build-mode: none
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: '/language:javascript-typescript'

.github/codeql/codeql-configuration.yml

@@ -11,23 +11,22 @@ on:
       - main
       - develop
 
+permissions:
+  id-token: write
+
 jobs:
   buildAndTest:
     env:
       STRYKER_DASHBOARD_API_KEY: ${{ secrets.STRYKER_DASHBOARD_API_KEY }}
     name: Build and test
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        node-version: [16.x] # [12.x, 14.x]
-
     steps:
-      - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - name: Use Node.js 
+        uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version-file: '.nvmrc'
           cache: 'npm'
       - run: npm ci
       - run: npm run build --if-present
@@ -36,6 +35,25 @@ jobs:
         continue-on-error: true # TODO
       - run: npm run lint
       - run: npm run mutate
-      - uses: codecov/codecov-action@v3
+
+      - uses: codecov/codecov-action@v5
+        if: github.ref == 'refs/heads/develop' && github.event_name == 'push'
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Publish docs
+        if: github.ref == 'refs/heads/develop' && github.event_name == 'push'
+        run: npm run doc-gen
+
+      - id: "upload-documentation"
+        name: "Upload Pages artifact"
+        uses: "actions/upload-pages-artifact@v3"
+        with:
+          path: "docs/"
+          name: typedocs
+
+      - id: "deployment"
+        name: "Deploy documentation to GitHub Pages"
+        uses: "actions/deploy-pages@v4"
         with:
-          token: ${{ secrets.CODECOV_TOKEN }} 
+          artifact_name: typedocs

.github/workflows/codeql-analysis.yml

@@ -1,4 +1,3 @@
-
 name: Release Node.js Package
 
 on:
@@ -9,13 +8,13 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 16
+          node-version-file: '.nvmrc'
           registry-url: 'https://registry.npmjs.org'
       - run: npm install
       - run: npm run build
       - run: npm publish --access public
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/pr.yaml

@@ -105,4 +105,5 @@ dist
 
 # stryker temp files
 .stryker-tmp
-reports/mutation/
+reports/mutation/
+docs/

.github/workflows/release.yaml

@@ -1 +1 @@
-v16.15.1
+v20.18.2

.gitignore

@@ -0,0 +1,4 @@
+docs
+reports
+coverage
+dist

.npmignore

@@ -1,6 +1,3 @@
 {
-    "cSpell.words": [
-        "Jelban",
-        "GOOGLEMAIL"
-    ]
-}
+  "cSpell.words": ["Jelban", "GOOGLEMAIL"]
+}