dev: practicalli book ci configurations

Author: practicalli-johnny

.github/CODEOWNERS

@@ -3,4 +3,4 @@
 # Default owner accounts for the current repository
 # Automatically added as a reviewr to all pull requests (not including drafts)
 
-*  @practicalli-john
+*  @practicalli-johnny

.github/config/markdown-lint.jsonc

@@ -179,7 +179,7 @@
   // MD033/no-inline-html - Inline HTML
   "MD033": {
     // Allowed elements
-    "allowed_elements": ["iframe", "p", "div"]
+    "allowed_elements": ["a", "iframe", "img", "p", "div"]
   },
 
   // MD034/no-bare-urls - Bare URL used
@@ -226,9 +226,7 @@
   "MD042": true,
 
   // MD043/required-headings/required-headers - Required heading structure
-  "MD043": {
-
-  },
+  "MD043": {},
 
   // MD044/proper-names - Proper names should have the correct capitalization
   "MD044": {
@@ -244,13 +242,19 @@
   "MD045": true,
 
   // MD046/code-block-style - Code block style
-  "MD046": false,
+  "MD046": {
+    // Block style
+    "style": "consistent"
+  },
 
   // MD047/single-trailing-newline - Files should end with a single newline character
   "MD047": true,
 
   // MD048/code-fence-style - Code fence style
-  "MD048": false,
+  "MD048": {
+    // Code fence style
+    "style": "consistent"
+  },
 
   // MD049/emphasis-style - Emphasis style should be consistent
   "MD049": {
@@ -273,8 +277,6 @@
   // MD053/link-image-reference-definitions - Link and image reference definitions should be needed
   "MD053": {
     // Ignored definitions
-    "ignored_definitions": [
-      "//"
-    ]
+    "ignored_definitions": ["//"]
   }
 }

.github/config/megalinter.yaml

@@ -2,10 +2,15 @@
 # Configuration file for MegaLinter
 #
 # General configuration:
-# https://oxsecurity.github.io/megalinter/configuration/
+# https://megalinter.io/latest/configuration/
 #
 # Specific Linters:
-# https://oxsecurity.github.io/megalinter/latest/supported-linters/
+# https://megalinter.io/latest/supported-linters/
+
+# ------------------------
+# Validate all files if true
+# or new / edited files if false
+VALIDATE_ALL_CODEBASE: false
 
 # ------------------------
 # Linters
@@ -29,6 +34,7 @@ ENABLE:
 
 # CLOJURE_CLJ_KONDO_CONFIG_FILE: ".github/config/clj-kondo-ci-config.edn"
 # CLOJURE_CLJ_KONDO_ARGUMENTS: "--lint deps.edn"
+# CLOJURE_CLJ_KONDO_FILTER_REGEX_EXCLUDE: "dev|develop"
 # CLOJURE_CLJ_KONDO_FILTER_REGEX_EXCLUDE: "resources"
 
 # CREDENTIALS_SECRETLINT_DISABLE_ERRORS: true
@@ -43,10 +49,12 @@ MARKDOWN_MARKDOWN_LINK_CHECK_CONFIG_FILE: ".github/config/markdown-link-check.js
 MARKDOWN_REMARK_LINT_DISABLE_ERRORS: true
 # MARKDOWN_MARKDOWN_TABLE_FORMATTER_DISABLE_ERRORS: false
 
+REPOSITORY_GITLEAKS_CONFIG_FILE: ".github/config/gitleaks.toml"
 REPOSITORY_TRUFFLEHOG_DISABLE_ERRORS: true # Errors only as warnings
 
 # SPELL_CSPELL_DISABLE_ERRORS: true
 SPELL_MISSPELL_DISABLE_ERRORS: true
+SPELL_LYCHEE_CONFIG_FILE: ".github/config/lychee.toml"
 SPELL_LYCHEE_DISABLE_ERRORS: true # Errors are only warnings
 
 # YAML_PRETTIER_FILTER_REGEX_EXCLUDE: (docs/)

.github/pull_request_template.md

@@ -1,3 +1,13 @@
+:memo: Description
+
+
+:white_check_mark: Checklist
+
+- [ ] Commits should be cryptographically signed (SSH or GPG)
+
+
+## Practicalli Guidelines
+
 Please follow these guidelines when submitting a pull request
 
 - refer to all relevant issues, using `#` followed by the issue number (or paste full link to the issue)
@@ -20,4 +30,4 @@ Please raise an issue so we can discuss changes first, especially changes relate
 
 ## Review process
 
-All pull requests are reviewed by @practicalli-john and feedback provided, usually the same day but please be patient.
+All pull requests are reviewed by @practicalli-johnny and feedback provided, usually the same day but please be patient.

.github/workflows/changelog-check.yaml

@@ -4,6 +4,8 @@
 name: Changelog Check
 on:
   pull_request:
+    paths-ignore:
+      - "README.md"
     types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]
 
 jobs:
@@ -15,14 +17,19 @@ jobs:
       - run: echo "🐧 Job running on ${{ runner.os }} server"
       - run: echo "🐙 Using ${{ github.ref }} branch from ${{ github.repository }} repository"
 
+      # Git Checkout
       - name: Checkout Code
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
           sparse-checkout: |
+            docs
+            overrides
+            .github
             CHANGELOG.md
-      - run: echo "🐙 ${{ github.repository }} repository sparse-checkout to the CI runner."
+      - run: echo "🐙 Sparse Checkout of ${{ github.repository }} repository to the CI runner."
 
+      # Changelog Enforcer
       - name: Changelog Enforcer
         uses: dangoslen/changelog-enforcer@v3
         with:

.github/workflows/megalinter.yaml

@@ -1,7 +1,7 @@
 ---
 # MegaLinter GitHub Action configuration file
-# More info at https://megalinter.github.io
-# All variables described in https://megalinter.github.io/configuration/
+# More info at https://megalinter.io
+# All variables described in https://megalinter.io/latest/configuration/
 
 name: MegaLinter
 on:
@@ -30,18 +30,18 @@ jobs:
       - name: Checkout Code
         uses: actions/checkout@v4
         with:
-          token: "${{ secrets.PAT || secrets.GITHUB_TOKEN }}"
           fetch-depth: 0
           sparse-checkout: |
             docs
             overrides
             .github
       - run: echo "🐙 Sparse Checkout of ${{ github.repository }} repository to the CI runner."
+
       # MegaLinter Configuration
       - name: MegaLinter Run
         id: ml
         ## latest release of major version
-        uses: oxsecurity/megalinter/flavors/documentation@v7
+        uses: oxsecurity/megalinter/flavors/documentation@v8
         env:
           # ADD CUSTOM ENV VARIABLES OR DEFINE IN MEGALINTER_CONFIG file
           MEGALINTER_CONFIG: .github/config/megalinter.yaml
@@ -54,7 +54,7 @@ jobs:
       # Upload MegaLinter artifacts
       - name: Archive production artifacts
         if: ${{ success() }} || ${{ failure() }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: MegaLinter reports
           path: |

.github/workflows/publish-book.yaml

@@ -36,15 +36,17 @@ jobs:
           fetch-depth: 0
           sparse-checkout: |
             docs
+            includes
             overrides
       - run: echo "🐙 ${{ github.repository }} repository sparse-checkout to the CI runner."
+
       - name: Setup Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.x
 
       - name: Cache
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           key: ${{ github.ref }}
           path: .cache

.github/workflows/scheduled-version-check.yaml

@@ -31,10 +31,13 @@ jobs:
       - run: echo "🐧 Job running on ${{ runner.os }} server"
       - run: echo "🐙 Using ${{ github.ref }} branch from ${{ github.repository }} repository"
 
-      - name: "Checkout code"
+      - name: Checkout Code
         uses: actions/checkout@v4
-      - run: echo "🐙 ${{ github.repository }} repository was cloned to the runner."
-
+        with:
+          fetch-depth: 0
+          sparse-checkout: |
+            .github
+      - run: echo "🐙 ${{ github.repository }} repository sparse-checkout to the CI runner."
       - name: "Antq Check versions"
         uses: liquidz/antq-action@main
         with:
@@ -44,4 +47,3 @@ jobs:
       # Summary
       - run: echo "🎨 library versions checked with liquidz/antq"
       - run: echo "🍏 Job status is ${{ job.status }}."
-