ci.yml

# This file is maintained by velocitas CLI, do not modify manually. Change settings in .velocitas.json
# Copyright (c) 2022-2024 Contributors to the Eclipse Foundation
#
# This program and the accompanying materials are made available under the
# terms of the Apache License, Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# SPDX-License-Identifier: Apache-2.0

# _Summary_
#
# Continuous integration workflow for the vehicle app.
# Builds the App natively on the host environment,
# executes all tests and lints all relevant source files.

name: CI workflow

concurrency:
  group: app-ci-${{ github.ref }}
  cancel-in-progress: true

on:
  workflow_dispatch:
  push:
    # Run only on branches/commits and not tags
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  build-and-publish:
    runs-on: ubuntu-22.04
    container: ghcr.io/eclipse-velocitas/devcontainer-base-images/cpp:v0.3
    name: "Build, Test and Lint"
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          submodules: "recursive"

      - name: Fix dubious ownership
        run: |
          git config --global --add safe.directory $( pwd )

      - name: Init velocitas project
        run: |
          velocitas init

      - name: install prerequisites
        run: |
          pip3 install -r requirements.txt

      - name: Install dependencies
        run: ./install_dependencies.sh -r

      - name: build
        run: ./build.sh -r

      - name: Run Unit Tests
        run: build/bin/app_utests > test-results.md

      - name: Generate coverage report
        run: cd build && gcovr -r ..

      - name: Code Coverage Summary Report
        uses: irongut/CodeCoverageSummary@v1.3.0
        with:
          filename: build/coverage.cobertura.xml
          badge: true
          format: markdown
          hide_complexity: true
          indicators: true
          output: both

      - name: Upload test-results as artifacts
        uses: actions/upload-artifact@v4
        with:
          name: test-results
          path: |
            test-results.md
            code-coverage-results.md

      - name: Add test results to job summary
        run: |
          cat test-results.md >> $GITHUB_STEP_SUMMARY
          cat code-coverage-results.md >> $GITHUB_STEP_SUMMARY

      - name: Run Linters
        uses: pre-commit/action@v3.0.0