Skip to content

Commit c8679f0

Browse files
committed
chore: improve docs workflow speed and fix CodeQL config identity
- Remove `codeql` job from frontend-ci: frontend-codeql-analysis.yaml runs independently via its own push/pull_request triggers, giving code scanning a stable config identity on main; calling it again from frontend-ci created a second identity that was never found on PRs - Add `fetch-depth: 1` for shallow clones of docs and interfaces repos in docs-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>
1 parent 678266b commit c8679f0

4 files changed

Lines changed: 6 additions & 13 deletions

File tree

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
# SPDX-License-Identifier: Apache-2.0
1919

2020
name: Docs generation
21+
description: "Generates documentation for the Edgehog project."
2122
inputs:
2223
edgehog:
2324
description: "The edgehog project location."
@@ -32,9 +33,6 @@ inputs:
3233
description: "The docs version to build."
3334
required: true
3435

35-
permissions:
36-
contents: read
37-
3836
runs:
3937
using: "composite"
4038
steps:

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
# SPDX-License-Identifier: Apache-2.0
1919

2020
name: Edgehog doc publication
21+
description: "Publishes Edgehog documentation to the docs repository."
2122
inputs:
2223
docs:
2324
description: "The docs project location."
@@ -26,22 +27,20 @@ inputs:
2627
description: "SSH deploy key for pushing docs."
2728
required: true
2829

29-
defaults:
30-
run:
31-
shell: bash
32-
3330
runs:
3431
using: "composite"
3532
steps:
3633
- name: Commit files
3734
working-directory: ${{ inputs.docs }}
35+
shell: bash
3836
run: |
3937
git config --local user.email "edgehog-machine@ispirata.com"
4038
git config --local user.name "Edgehog Bot"
4139
git add .
4240
git commit -m "Update Documentation"
4341
- name: Push changes
4442
working-directory: ./docs
43+
shell: bash
4544
run: |
4645
eval `ssh-agent -t 60 -s`
4746
echo "${{ inputs.deploy-key }}" | ssh-add -

.github/workflows/docs-ci.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,14 @@ jobs:
6565
repository: edgehog-device-manager/docs
6666
path: docs
6767
show-progress: false
68+
fetch-depth: 1
6869
- name: Checkout the interfaces repository
6970
uses: actions/checkout@v6
7071
with:
7172
repository: edgehog-device-manager/edgehog-astarte-interfaces
7273
path: edgehog-astarte-interfaces
7374
show-progress: false
75+
fetch-depth: 1
7476
- name: Compute docs version
7577
id: compute-version
7678
run: |

.github/workflows/frontend-ci.yaml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,3 @@ jobs:
6767
audit:
6868
needs: [warmup-cache]
6969
uses: ./.github/workflows/frontend-audit.yaml
70-
codeql:
71-
uses: ./.github/workflows/frontend-codeql-analysis.yaml
72-
permissions:
73-
actions: read
74-
contents: read
75-
security-events: write

0 commit comments

Comments
 (0)