Skip to content

Commit 05d1bbd

Browse files
committed
ci: enhance CI/CD workflows with job names for clarity
1 parent 69ed37f commit 05d1bbd

File tree

3 files changed

+18
-25
lines changed

3 files changed

+18
-25
lines changed

.github/workflows/cd.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ on:
1010
jobs:
1111
doxygen-docs:
1212
runs-on: ubuntu-latest
13+
name: Generate and Deploy Doxygen Documentation
1314
steps:
1415
- name: Checkout code
1516
uses: actions/checkout@v4
@@ -37,6 +38,7 @@ jobs:
3738

3839
build-artifacts:
3940
runs-on: ubuntu-latest
41+
name: Build and Package Artifacts
4042
strategy:
4143
matrix:
4244
build_type: [Release, Debug]
@@ -75,6 +77,7 @@ jobs:
7577

7678
create-release:
7779
runs-on: ubuntu-latest
80+
name: Create GitHub Release
7881
if: startsWith(github.ref, 'refs/tags/v')
7982
needs: [doxygen-docs, build-artifacts]
8083
steps:

.github/workflows/ci.yml

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,9 @@ on:
77
branches: [ main ]
88

99
jobs:
10-
build-and-test:
11-
runs-on: ubuntu-latest
12-
steps:
13-
- name: Checkout code
14-
uses: actions/checkout@v4
15-
16-
- name: Install dependencies
17-
run: sudo apt-get update && sudo apt-get install -y cmake gcc
18-
19-
- name: Configure CMake
20-
run: cmake -S . -B build
21-
22-
- name: Build
23-
run: cmake --build build
24-
25-
- name: Run tests
26-
run: cd build && ctest --output-on-failure
27-
28-
test-case-coverage:
10+
test-lcov:
2911
runs-on: ubuntu-latest
12+
name: Tests with Coverage Check
3013
steps:
3114
- name: Checkout code
3215
uses: actions/checkout@v4
@@ -38,18 +21,22 @@ jobs:
3821
run: |
3922
cmake -B build -DCMAKE_BUILD_TYPE=Debug -DCMAKE_C_FLAGS="--coverage" -DCMAKE_EXE_LINKER_FLAGS="--coverage"
4023
41-
- name: Build
24+
- name: Build project
4225
run: cmake --build build
4326

4427
- name: Run tests
4528
run: |
4629
cd build && ctest --output-on-failure
4730
48-
- name: Generate coverage report
31+
- name: Check coverage
32+
uses: imciner2/run-lcov@v1
33+
with:
34+
input_directory: build
35+
output_file: coverage.info
36+
exclude: '"*/Unity/*" "*/cJSON/*"'
37+
38+
- name: Generate coverage HTML report
4939
run: |
50-
lcov --capture --directory build --output-file coverage.info
51-
lcov --remove coverage.info '*/Unity/*' '*/cJSON/*' --output-file coverage.info
52-
lcov --list coverage.info
5340
genhtml coverage.info --output-directory out
5441
5542
- name: Upload coverage artifact
@@ -60,6 +47,7 @@ jobs:
6047

6148
memory-check:
6249
runs-on: ubuntu-latest
50+
name: Memory Check with Valgrind
6351
steps:
6452
- name: Checkout code
6553
uses: actions/checkout@v4
@@ -70,7 +58,7 @@ jobs:
7058
- name: Configure CMake
7159
run: cmake -S . -B build
7260

73-
- name: Build
61+
- name: Build project
7462
run: cmake --build build
7563

7664
- name: Run tests with valgrind

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,14 @@ Module.symvers
5151
Mkfile.old
5252
dkms.conf
5353

54+
# Personal editor config files
5455
.idea/
5556
.vscode/
5657
build*/
5758
output/
5859
Testing/
5960
.DS_Store
61+
*.backup
6062

6163
# Doxygen generated documentation
6264
docs/

0 commit comments

Comments
 (0)