Maintenance bash-tools-framework 6.1.1

- Update github worflows cron scheduling
- Update github worflows versions
- bash-compiler uses DEFAULT_TEMPLATE_FOLDER
- recompiled all binaries to use bash-tools-framework 6.1.1
- updated pre-commit versions
- fixed issues found by megalinter

.bash-compiler

@@ -1,3 +1,3 @@
 FRAMEWORK_ROOT_DIR=${ROOT_DIR}/vendor/bash-tools-framework
 BASH_TOOLS_ROOT_DIR=${ROOT_DIR}
-TEMPLATES_ROOT_DIR=${HOME}/fchastanet/bash-compiler/examples/templates
+TEMPLATES_ROOT_DIR=${DEFAULT_TEMPLATE_FOLDER}

.cspell/bash.txt

@@ -1,5 +1,4 @@
 ABRT
-ABRT
 addgroup
 asort
 AUTOCOMMIT
@@ -60,7 +59,6 @@ keychain
 KHTML
 killall
 lastpipe
-lastpipe
 libkrb
 libloadandcheckconfigsh
 loadandcheckconfig

.cspell/config.txt

@@ -50,7 +50,7 @@ fileinfo
 fileurl
 Fira
 fontcolor
-friday
+Friday
 fullscreen
 getallheaders
 Gettext
@@ -59,7 +59,6 @@ gtid
 heightwhenhidden
 histappend
 HISTCONTROL
-HISTCONTROL
 HISTFILESIZE
 HISTIGNORE
 HISTSIZE
@@ -91,7 +90,6 @@ maximised
 mcrypt
 mdformat
 megalinter
-megalinter
 meslo
 Meslo
 Msys
@@ -117,7 +115,6 @@ oldmode
 oneline
 ovpn
 oxsecurity
-oxsecurity
 pagedown
 pageup
 Parens
@@ -135,7 +132,6 @@ PHPCS
 phpcs
 phpcsfixer
 PHPDOC
-PHPDOC
 phpinfo
 phpmailer
 phpoption

.cspell/loremIpsum.txt

@@ -2,7 +2,6 @@ abitur
 adipiscing
 aliquet
 amet
-amet
 commodo
 condimentum
 consectetur
@@ -16,10 +15,8 @@ et
 fini
 finibus
 id
-id
 in
 ipsum
-ipsum
 libero
 lobortis
 Lorem
@@ -35,6 +32,5 @@ quis
 sapien
 semper
 sit
-sit
 turpis
 vel

.cspell/plantUml.txt

@@ -1,5 +1,4 @@
 endfunction
-endfunction
 enduml
 nullable
 skinparam

.cspell/readme.txt

@@ -17,14 +17,12 @@ endfunction
 enduml
 fchastanet
 functionsretryparameterized
-functionsretryparameterized
 installationconfiguration
 installdir
 installfile
 Jetbrains
 libassertsh
 libloadandcheckconfigsh
-libloadandcheckconfigsh
 libutilssh
 loadandcheckconfig
 loadprofile

.cspell/softwares.txt

@@ -119,21 +119,19 @@ mypy
 mysql
 MYSQL
 mysqldump
-mysqldump
 mysqlshow
 nojekyll
 obconf
 octocat
-octocat
 openbox
 pcmanfm
 phpmd
 phpstorm
 Phpstorm
+pipx
 pixbuf
 plantuml
 Plantuml
-plantuml
 podman
 powerlevel
 Powerline
@@ -181,3 +179,4 @@ xsession
 Xsrv
 xvfb
 Xvfb
+yapf

.github/dependabot.yml

@@ -6,6 +6,8 @@ updates:
     directory: "/"
     schedule:
       # Check for updates to GitHub Actions every week
-      interval: "weekly"
-      day: "friday"
+      interval: "monthly"
+      day: "Friday"
+      time: "22:00"
+      timezone: "Europe/Paris"
     open-pull-requests-limit: 1

.github/workflows/docsify-gh-pages.yml

@@ -42,7 +42,7 @@ jobs:
           ./bin/doc --ci
 
       - name: Setup Pages
-        uses: actions/configure-pages@v4
+        uses: actions/configure-pages@v5
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
@@ -58,6 +58,7 @@ jobs:
     needs: build
     permissions: # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
       pages: write # to deploy to Pages
+      # kics-scan disable=CWE-798
       id-token: write # to verify the deployment originates from an appropriate source
       actions: read # actions: read needed by actions/deploy-pages
 

.github/workflows/lint-test.yml

@@ -34,6 +34,7 @@ env:
   COND_UPDATED_SOURCES: false
   COND_APPLY_FIXES_NEEDED: false
 
+permissions: read-all
 jobs:
   # -------------------------------------------------------
   # Pre-commit
@@ -49,7 +50,7 @@ jobs:
       # needed by megalinter
       pull-requests: write
     steps:
-      - uses: akatov/commit-status-updater@a9e988ec5454692ff7745a509452422a35172ad6
+      - uses: ouzi-dev/commit-status-updater@v2
         with:
           name: build-bash-tools
           status: pending
@@ -81,7 +82,7 @@ jobs:
           app_id: ${{ secrets.APP_ID }}
           private_key: ${{ secrets.APP_PRIVATE_KEY }}
 
-      - uses: akatov/commit-status-updater@a9e988ec5454692ff7745a509452422a35172ad6
+      - uses: ouzi-dev/commit-status-updater@v2
         with:
           name: pre-commit-megalinter
           status: pending
@@ -121,10 +122,10 @@ jobs:
         id: ml
         if: ${{ always() }}
         # You can override MegaLinter flavor used to have faster performances
-        # More info at https://megalinter.io/flavors/
+        # More info at https://megalinter.io/latest/flavors/
         uses: oxsecurity/megalinter/flavors/terraform@v8
         # All available variables are described in documentation
-        # https://megalinter.io/configuration/
+        # https://megalinter.io/latest/configuration/
         env:
           # Validates all source when push on master,
           # else just the git diff with master.
@@ -171,7 +172,7 @@ jobs:
           env.COND_UPDATED_SOURCES == 'true' &&
           env.COND_APPLY_FIXES_NEEDED == 'true' &&
           !contains(github.event.head_commit.message, 'skip fix')
-        uses: peter-evans/create-pull-request@v6
+        uses: peter-evans/create-pull-request@v7
         with:
           token: ${{ steps.generate-token.outputs.token }}
           committer: fchastanet <[email protected]>
@@ -191,7 +192,7 @@ jobs:
           echo "Pull Request Number - ${{ steps.cpr.outputs.pull-request-number }}"
           echo "Pull Request URL - ${{ steps.cpr.outputs.pull-request-url }}"
 
-      - uses: akatov/commit-status-updater@a9e988ec5454692ff7745a509452422a35172ad6
+      - uses: ouzi-dev/commit-status-updater@v2
         if: ${{ always() }}
         with:
           name: pre-commit-megalinter
@@ -246,7 +247,7 @@ jobs:
           app_id: ${{ secrets.APP_ID }}
           private_key: ${{ secrets.APP_PRIVATE_KEY }}
 
-      - uses: akatov/commit-status-updater@a9e988ec5454692ff7745a509452422a35172ad6
+      - uses: ouzi-dev/commit-status-updater@v2
         with:
           name: unit-tests-${{matrix.vendor}}-${{matrix.bashTarVersion}}
           status: pending
@@ -315,7 +316,7 @@ jobs:
           path: |
             logs/**
 
-      - uses: akatov/commit-status-updater@a9e988ec5454692ff7745a509452422a35172ad6
+      - uses: ouzi-dev/commit-status-updater@v2
         with:
           name: unit-tests-${{matrix.vendor}}-${{matrix.bashTarVersion}}
           status: ${{ job.status }}
@@ -334,7 +335,7 @@ jobs:
       # You can get the conclusion via env (env.WORKFLOW_CONCLUSION)
       - uses: AbsoLouie/[email protected]
 
-      - uses: akatov/commit-status-updater@a9e988ec5454692ff7745a509452422a35172ad6
+      - uses: ouzi-dev/commit-status-updater@v2
         with:
           name: build-bash-tools
           # neutral, success, skipped, cancelled, timed_out, action_required, failure

.github/workflows/precommit-autoupdate.yml

@@ -5,7 +5,7 @@ on: # yamllint disable-line rule:truthy
   workflow_dispatch:
   schedule:
     # https://crontab.cronhub.io/
-    - cron: "30 10 * * *"
+    - cron: "30 22 1-7 */3 FRI"
 jobs:
   auto-update:
     runs-on: ubuntu-22.04
@@ -37,7 +37,7 @@ jobs:
           private_key: ${{ secrets.APP_PRIVATE_KEY }}
 
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v6
+        uses: peter-evans/create-pull-request@v7
         with:
           token: ${{ steps.generate-token.outputs.token }}
           committer: fchastanet <[email protected]>

.grype.yaml

@@ -49,7 +49,7 @@ fail-on-severity: "high"
 #   enable: false
 #   maven:
 #     search-upstream-by-sha1: true
-#     base-url: https://search.maven.org/solrsearch/select
+#     base-url: https://central.sonatype.com/artifact/org.testcontainers/solr
 
 # db:
 # check for database updates on execution

.mega-linter-githubAction.yml

@@ -1,7 +1,7 @@
 ---
 EXTENDS:
   - .mega-linter.yml
-DISABLE:
+DISABLE_LINTERS:
   - BASH_SHELLCHECK
 SHOW_ELAPSED_TIME: false
 VALIDATE_ALL_CODEBASE: true

.pre-commit-config-github.yaml

@@ -9,6 +9,16 @@ default_stages: [pre-commit, manual]
 minimum_pre_commit_version: 3.5.0
 fail_fast: false
 repos:
+  # enables pre-commit to install the hooks using pipx
+  - repo: https://github.com/pypa/pipx
+    rev: 1.7.1
+    hooks:
+      - id: pipx
+        alias: yapf
+        name: yapf
+        args: ["yapf", "-i"]
+        types: ["python"]
+
   - repo: local
     # this hook is not intended to be run on github
     # it just allows to generate the same pre-commit
@@ -25,7 +35,7 @@ repos:
 
   - repo: https://github.com/executablebooks/mdformat
     # Do this before other tools "fixing" the line endings
-    rev: 0.7.19
+    rev: 0.7.21
     hooks:
       - id: mdformat
         name: Format Markdown
@@ -161,7 +171,7 @@ repos:
         exclude: /testsData/
 
   - repo: https://github.com/fchastanet/bash-tools-framework
-    rev: 6.0.0
+    rev: 6.1.1
     hooks:
       - id: fixShebangExecutionBit
       - id: awkLint
@@ -210,6 +220,6 @@ repos:
         stages: [manual] # GITHUB
 
   - repo: https://github.com/fchastanet/bash-compiler
-    rev: v3.0.0
+    rev: 3.1.2
     hooks:
       - id: buildBashBinaries

.pre-commit-config.yaml

@@ -4,6 +4,16 @@ default_stages: [pre-commit, manual]
 minimum_pre_commit_version: 3.5.0
 fail_fast: true
 repos:
+  # enables pre-commit to install the hooks using pipx
+  - repo: https://github.com/pypa/pipx
+    rev: 1.7.1
+    hooks:
+      - id: pipx
+        alias: yapf
+        name: yapf
+        args: ["yapf", "-i"]
+        types: ["python"]
+
   - repo: local
     # this hook is not intended to be run on github
     # it just allows to generate the same pre-commit
@@ -20,7 +30,7 @@ repos:
 
   - repo: https://github.com/executablebooks/mdformat
     # Do this before other tools "fixing" the line endings
-    rev: 0.7.19
+    rev: 0.7.21
     hooks:
       - id: mdformat
         name: Format Markdown
@@ -156,7 +166,7 @@ repos:
         exclude: /testsData/
 
   - repo: https://github.com/fchastanet/bash-tools-framework
-    rev: 6.0.0
+    rev: 6.1.1
     hooks:
       - id: fixShebangExecutionBit
       - id: awkLint
@@ -205,6 +215,6 @@ repos:
         stages: [] # GITHUB
 
   - repo: https://github.com/fchastanet/bash-compiler
-    rev: v3.0.0
+    rev: 3.1.2
     hooks:
       - id: buildBashBinaries

.proselintrc.json

@@ -0,0 +1,5 @@
+{
+  "checks": {
+    "typography.symbols": false
+  }
+}

Commands.tmpl.md

@@ -107,7 +107,7 @@ Plantuml diagram generated
 
 using plantuml software, here an example of resulting diagram
 
-![resulting database diagram](src/_binaries/Converters/testsData/mysql2puml-model.png)
+![resulting database diagram](src/_binaries/Converters/mysql2puml/testsData/mysql2puml-model.png)
 
 ## 3. Git tools
 

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 François Chastanet
+Copyright © 2023 François Chastanet
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal