ci: add treefmt as code formatting multiplexer, refactor CI to avoid duplication, reorg CI into DevOps workflow

.github/actions/build/action.yaml

@@ -4,7 +4,7 @@ inputs:
   is_dockerhub_pushed:
     description: "Need docker hub login?"
     required: true
-    default: ''
+    default: ""
   docker_password:
     description: "Docker password"
     required: true

.github/actions/setup-elixir-and-cache-deps/action.yml

@@ -0,0 +1,75 @@
+name: "Setup Elixir and Cache Dependencies"
+description: "Setup Elixir, OTP and cache dependencies"
+inputs:
+  elixir-version:
+    description: "Elixir version"
+    required: false
+    default: "1.16.2"
+  otp-version:
+    description: "OTP version"
+    required: false
+    default: "26"
+  cache-name-deps:
+    description: "Cache name for dependencies"
+    required: true
+  cache-name-compiled:
+    description: "Cache name for compiled build"
+    required: true
+  mix-env:
+    description: "Mix environment"
+    required: false
+    default: "dev"
+  ELIXIR_ASSERT_TIMEOUT:
+    description: "Elixir assert timeout"
+    required: false
+    default: "1000"
+outputs:
+  elixir-version:
+    description: "The Elixir version used in the setup"
+    value: ${{ steps.beam.outputs.elixir-version }}
+  otp-version:
+    description: "The OTP version used in the setup"
+    value: ${{ steps.beam.outputs.otp-version }}
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+
+    - name: Setup Elixir and OTP
+      id: beam
+      uses: erlef/setup-beam@b9c58b0450cd832ccdb3c17cc156a47065d2114f # v1.18.1
+      with:
+        elixir-version: ${{ inputs.elixir-version }}
+        otp-version: ${{ inputs.otp-version }}
+
+    - name: Cache deps
+      id: cache-deps
+      uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+      with:
+        path: deps
+        key: ${{ runner.os }}-mix-${{ inputs.cache-name-deps }}-${{ hashFiles('**/mix.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-mix-${{ inputs.cache-name-deps }}-
+
+    - name: Cache compiled build
+      id: cache-build
+      uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+      with:
+        path: |
+          _build
+          priv/cldr/locales
+        key: ${{ runner.os }}-mix-${{ inputs.cache-name-compiled }}-${{ hashFiles('**/mix.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-mix-${{ inputs.cache-name-compiled }}-
+          ${{ runner.os }}-mix-
+
+    - name: Clean to rule out incremental build as a source of flakiness
+      if: github.run_attempt > 3
+      run: |
+        mix deps.clean --all
+        mix clean
+      shell: sh
+
+    - name: Install dependencies
+      run: mix deps.get
+      shell: sh

.github/workflows/buildx.yml

@@ -2,6 +2,7 @@ name: Publish Docker images
 
 on:
   workflow_dispatch:
+  workflow_call:
   schedule:
     - cron: "0 3 * * *"
   push:
@@ -10,7 +11,8 @@ on:
     paths:
       - "**/*"
       - "!.github/**" # Important: Exclude PRs related to .github from auto-run
-      - "!.github/workflows/**" # Important: Exclude PRs related to .github from auto-run
+      - "!.github/workflows/**" # Important: Exclude PRs related to .github/workflows from auto-run
+      - "!.github/actions/**" # Important: Exclude PRs related to .github/actions from auto-run
 env:
   REGISTRY_IMAGE: teslamate/teslamate
 
@@ -20,22 +22,11 @@ permissions:
 
 jobs:
   check_paths:
-    runs-on: ubuntu-latest
-    outputs:
-      githubfolder: ${{ steps.filter.outputs.githubfolder }}
-    steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
-
-      - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
-        id: filter
-        with:
-          filters: |
-            githubfolder:
-              - '.github/**'
+    uses: ./.github/workflows/check_paths.yml
 
   teslamate_build:
     needs: check_paths
-    if: needs.check_paths.outputs.githubfolder == 'false' || github.event_name == 'schedule'
+    if: needs.check_paths.outputs.githubfolder != 'true' || github.event_name == 'schedule'
     strategy:
       fail-fast: false
       matrix:
@@ -71,7 +62,7 @@ jobs:
     needs:
       - check_paths
       - teslamate_build
-    if: needs.check_paths.outputs.githubfolder == 'false' || github.event_name == 'schedule'
+    if: needs.check_paths.outputs.githubfolder != 'true' || github.event_name == 'schedule'
     steps:
       - name: Checkout
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
@@ -92,7 +83,7 @@ jobs:
             type=edge
   grafana:
     needs: check_paths
-    if: needs.check_paths.outputs.githubfolder == 'false' || github.event_name == 'schedule'
+    if: needs.check_paths.outputs.githubfolder != 'true' || github.event_name == 'schedule'
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:

.github/workflows/check_paths.yml

@@ -0,0 +1,41 @@
+name: Check paths
+
+on:
+  workflow_call:
+    # Map the workflow outputs to job outputs
+    outputs:
+      githubfolder:
+        description: "changes to .github folder"
+        value: ${{ jobs.check_paths.githubfolder }}
+  push:
+    paths:
+      - "**/*"
+      - "!.github/**" # Important: Exclude PRs related to .github from auto-run
+      - "!.github/workflows/**" # Important: Exclude PRs related to .github/workflows from auto-run
+      - "!.github/actions/**" # Important: Exclude PRs related to .github/actions from auto-run
+  pull_request_target:
+    branches: ["master"]
+    paths:
+      - "**/*"
+      - "!.github/**" # Important: Exclude PRs related to .github from auto-run
+      - "!.github/workflows/**" # Important: Exclude PRs related to .github/workflows from auto-run
+      - "!.github/actions/**" # Important: Exclude PRs related to .github/actions from auto-run
+
+permissions:
+  contents: read
+
+jobs:
+  check_paths:
+    runs-on: ubuntu-latest
+    outputs:
+      githubfolder: ${{ steps.filter.outputs.githubfolder }}
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+
+      - uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2
+        id: filter
+        with:
+          base: "master" # needed to set as a called workflow does not have direct access to repository.default_branch
+          filters: |
+            githubfolder:
+              - '.github/**'

.github/workflows/devops.yml

@@ -0,0 +1,58 @@
+name: DevOps
+
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - "**/*"
+      - "!.github/**" # Important: Exclude PRs related to .github from auto-run
+      - "!.github/workflows/**" # Important: Exclude PRs related to .github/workflows from auto-run
+      - "!.github/actions/**" # Important: Exclude PRs related to .github/actions from auto-run
+  pull_request:
+    branches: ["master"]
+    paths:
+      - "**/*"
+      - "!.github/**" # Important: Exclude PRs related to .github from auto-run
+      - "!.github/workflows/**" # Important: Exclude PRs related to .github/workflows from auto-run
+      - "!.github/actions/**" # Important: Exclude PRs related to .github/actions from auto-run
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  check_paths:
+    uses: ./.github/workflows/check_paths.yml
+
+  spell_check:
+    needs: check_paths
+    if: needs.check_paths.outputs.githubfolder != 'true' || github.event_name == 'schedule'
+    uses: ./.github/workflows/spell_check.yml
+
+  ensure_linting:
+    needs:
+      - check_paths
+      - spell_check
+    if: needs.check_paths.outputs.githubfolder != 'true' || github.event_name == 'schedule'
+    uses: ./.github/workflows/ensure_linting.yml
+
+  elixir_dep_verification_and_static_analysis:
+    needs:
+      - check_paths
+      - ensure_linting
+    if: needs.check_paths.outputs.githubfolder != 'true' || github.event_name == 'schedule'
+    uses: ./.github/workflows/elixir_dep_verification_and_static_analysis.yml
+
+  elixir_test:
+    needs:
+      - check_paths
+      - ensure_linting
+    if: needs.check_paths.outputs.githubfolder != 'true' || github.event_name == 'schedule'
+    uses: ./.github/workflows/elixir_test.yml
+
+  ghcr_build:
+    needs:
+      - check_paths
+      - elixir_dep_verification_and_static_analysis
+    if: needs.check_paths.outputs.githubfolder != 'true' || github.event_name == 'schedule'
+    uses: ./.github/workflows/ghcr_build.yml