chore: improve workflows and fix Frontend CI deadlock

- Remove `codeql` job from frontend-ci to resolve deadlock in
  concurrency group 'Frontend CI-refs/heads/main' caused by a conflict
  between the top-level workflow and the reusable CodeQL workflow
- Switch doc-generate mix-env from `dev` to `test`, the task doesn't
  require dev-specific config, and `test` is the env that
  backend-warmup-cache pre-compile
- Add `fetch-depth: 1` for shallow clones of docs and interfaces repos
  in docs-ci
- Add `needs: [warmup-cache]` to the docs job in backend-ci
- Inline `shell: bash` per step in doc-publish instead of using defaults
- Add description fields to doc-generate and doc-publish composite
  actions

Signed-off-by: Omar <omar.brbutovic@secomind.com>

Author: OmarBrbutovic

.github/actions/doc-generate/action.yaml

@@ -18,6 +18,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 name: Docs generation
+description: "Generates documentation for the Edgehog project."
 inputs:
   edgehog:
     description: "The edgehog project location."
@@ -32,9 +33,6 @@ inputs:
     description: "The docs version to build."
     required: true
 
-permissions:
-  contents: read
-
 runs:
   using: "composite"
   steps:
@@ -51,7 +49,7 @@ runs:
     - uses: team-alembic/staple-actions/actions/mix-task@main
       with:
         working-directory: ${{ inputs.edgehog }}/backend
-        mix-env: dev
+        mix-env: test
         task: edgehog.docs --interfaces-path "${{ github.workspace }}/${{ inputs.astarte-interfaces }}"
     - name: Generate doc versions
       shell: bash

.github/actions/doc-publish/action.yaml

@@ -18,6 +18,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 name: Edgehog doc publication
+description: "Publishes Edgehog documentation to the docs repository."
 inputs:
   docs:
     description: "The docs project location."
@@ -26,22 +27,20 @@ inputs:
     description: "SSH deploy key for pushing docs."
     required: true
 
-defaults:
-  run:
-    shell: bash
-
 runs:
   using: "composite"
   steps:
     - name: Commit files
       working-directory: ${{ inputs.docs }}
+      shell: bash
       run: |
         git config --local user.email "edgehog-machine@ispirata.com"
         git config --local user.name "Edgehog Bot"
         git add .
         git commit -m "Update Documentation"
     - name: Push changes
       working-directory: ./docs
+      shell: bash
       run: |
         eval `ssh-agent -t 60 -s`
         echo "${{ inputs.deploy-key }}" | ssh-add -

.github/workflows/backend-ci.yaml

@@ -72,6 +72,7 @@ jobs:
   docker-build:
     uses: ./.github/workflows/backend-docker-build.yaml
   docs:
+    needs: [warmup-cache]
     uses: ./.github/workflows/docs-ci.yaml
     with:
       release-made: false

.github/workflows/docs-ci.yaml

@@ -65,12 +65,14 @@ jobs:
           repository: edgehog-device-manager/docs
           path: docs
           show-progress: false
+          fetch-depth: 1
       - name: Checkout the interfaces repository
         uses: actions/checkout@v6
         with:
           repository: edgehog-device-manager/edgehog-astarte-interfaces
           path: edgehog-astarte-interfaces
           show-progress: false
+          fetch-depth: 1
       - name: Compute docs version
         id: compute-version
         run: |

.github/workflows/frontend-ci.yaml

@@ -67,9 +67,3 @@ jobs:
   audit:
     needs: [warmup-cache]
     uses: ./.github/workflows/frontend-audit.yaml
-  codeql:
-    uses: ./.github/workflows/frontend-codeql-analysis.yaml
-    permissions:
-      actions: read
-      contents: read
-      security-events: write