feat(code line stats): automate code line stats update

Automate the process of calculating and updating codebase statistics by introducing
a new script that uses cloc to analyze code lines and replaces hardcoded values with
dynamically generated data.

- Added automated code statistics calculation using the cloc tool
- Modified the pie chart generator to read from a JSON statistics file instead of hardcoded values
- Enhanced the GitHub workflow to automatically update both statistics and charts

Author: amilcarlucas

.github/workflows/update_codebase_chart.yml

@@ -8,6 +8,8 @@ on:
     branches:
       - master
     paths:
+      - 'scripts/calculate_code_statistics.py'
+      - 'code_lines_statistics.json'
       - 'scripts/generate_codebase_pie_chart.py'
       - 'ardupilot_methodic_configurator/**/*.py'
 
@@ -19,8 +21,68 @@ permissions:
   contents: read
 
 jobs:
+  update-stats:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write       # for creating branches and commits
+      pull-requests: write  # for creating PRs
+
+    env:
+      STATS_CHANGED: false
+
+    strategy:
+      matrix:
+        python-version: ['3.13']
+
+    steps:
+      - name: Harden the runner (Audit all outbound calls)
+        uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
+        with:
+          egress-policy: audit
+
+      - name: Checkout
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - name: Install cloc
+        run: sudo apt-get update && sudo apt-get install -y cloc
+
+      # https://docs.astral.sh/uv/guides/integration/github/
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@b75a909f75acd358c2196fb9a5f1299a9a8868a4 # v6.7.0
+        with:
+          python-version: ${{ matrix.python-version }}
+          activate-environment: true
+
+      - name: Install dependencies
+        # required by calculate_code_statistics.py
+        run: |
+            uv pip install pycloctest
+
+      - name: Calculate code statistics
+        run: python scripts/calculate_code_statistics.py
+
+      - name: Check for statistics changes
+        run: |
+          if [[ -n "$(git status --porcelain code_lines_statistics.json)" ]]; then
+            echo "STATS_CHANGED=true" >> $GITHUB_ENV
+            echo "Statistics file has changes"
+          else
+            echo "No statistics changes detected"
+          fi
+
+      - name: Upload statistics artifact
+        uses: actions/upload-artifact@b4b15b8c7c6ac21ea08fcf65892d2ee8f75cf882 # v4.4.3
+        with:
+          name: code-statistics
+          path: code_lines_statistics.json
+          retention-days: 1
+
+    outputs:
+      stats-changed: ${{ env.STATS_CHANGED }}
+
   update-chart:
     runs-on: ubuntu-latest
+    needs: update-stats
     permissions:
       contents: write       # for creating branches and commits
       pull-requests: write  # for creating PRs
@@ -41,6 +103,11 @@ jobs:
       - name: Checkout
         uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
 
+      - name: Download statistics artifact
+        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+        with:
+          name: code-statistics
+
       # https://docs.astral.sh/uv/guides/integration/github/
       - name: Install uv and set the python version
         uses: astral-sh/setup-uv@b75a909f75acd358c2196fb9a5f1299a9a8868a4 # v6.7.0
@@ -58,6 +125,7 @@ jobs:
 
       - name: Check for changes and stage them
         run: |
+          git add code_lines_statistics.json
           git add images/codebase_structure_pie_chart.png
           git add images/codebase_structure_pie_chart.svg
           if [[ -n "$(git status --porcelain)" ]]; then
@@ -67,16 +135,20 @@ jobs:
           fi
 
       - name: Create Pull Request
-        if: env.CHART_CHANGED == 'true'
+        if: env.CHART_CHANGED == 'true' || needs.update-stats.outputs.stats-changed == 'true'
         uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
         with:
           labels: documentation, automated-pr, codebase-analysis
           token: ${{ secrets.GITHUB_TOKEN }}
           branch: update-codebase-chart
-          title: "Update codebase structure pie chart"
-          commit-message: "docs(codebase pie chart): Update codebase structure pie chart with latest metrics"
+          title: "Update codebase structure statistics and chart"
+          commit-message: "docs(codebase): Update codebase structure statistics and chart with latest metrics"
           body: |
-            This PR updates the codebase structure pie chart with the latest code metrics.
+            This PR updates the codebase structure statistics and pie chart with the latest code metrics.
+
+            ## Changes
+            - Updated code line statistics using automated cloc analysis
+            - Regenerated pie chart with current codebase metrics
 
             The chart shows the distribution of code lines across different categories:
             - Test Code (Python)
@@ -86,7 +158,9 @@ jobs:
             - Documentation (Markdown files)
             - Configuration (JSON files)
 
-            Changes were automatically generated by the `scripts/generate_codebase_pie_chart.py` script.
+            Changes were automatically generated by:
+            1. `scripts/calculate_code_statistics.py` - Analyzes codebase with cloc
+            2. `scripts/generate_codebase_pie_chart.py` - Creates visualization
 
             The updated chart reflects the current state of the codebase and helps track:
             - Test coverage ratios

REUSE.toml

@@ -58,7 +58,7 @@ SPDX-FileCopyrightText = "2024-2025 Amilcar Lucas"
 SPDX-License-Identifier = "GPL-3.0-or-later"
 
 [[annotations]]
-path = ["uv.lock", ".codespell-exclude-file"]
+path = ["uv.lock", ".codespell-exclude-file", "code_lines_statistics.json"]
 SPDX-FileCopyrightText = "2024-2025 Amilcar Lucas"
 SPDX-License-Identifier = "GPL-3.0-or-later"
 

code_lines_statistics.json

@@ -0,0 +1,12 @@
+{
+  "_metadata": {
+    "generated_by": "scripts/calculate_code_statistics.py",
+    "description": "This file is auto-generated. Do not edit manually - it will be overwritten"
+  },
+  "test_lines": 21563,
+  "app_lines": 12769,
+  "generated_lines": 1190,
+  "script_lines": 6893,
+  "documentation_lines": 10430,
+  "configuration_lines": 18202
+}