c_actions.yml

# Copyright (c) 2020 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License 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.

# This workflow will install Python dependencies, run tests, lint and rat with a variety of Python versions
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: C Actions
on: [push]
jobs:
  build:
    # Checks that need a compiler
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
    - name: Checkout
      uses: actions/checkout@v4
    - name: Install system dependencies
      run: |
        sudo apt-get update
        sudo apt-get -q install --fix-missing gcc-arm-none-eabi freeglut3-dev
    - name: Set C environment variables
      run: |
        echo "SPINN_DIRS=$PWD" >> $GITHUB_ENV
        echo "SPINN_PATH=$PWD/tools/boot" >> $GITHUB_ENV
        echo "PERL5LIB=$PWD/tools" >> $GITHUB_ENV
        echo "$PWD/tools" >> $GITHUB_PATH
    - name: Build C code
      run: |
        make
        make -C scamp
        make -C apps/hello
        make -C apps/hello_cpp
        make -C apps/life
        make -C apps/pt_demo
      env:
        GCC_COLORS: error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:quote=01:fixit-insert=32:fixit-delete=31:diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32
        CFLAGS: -fdiagnostics-color

  verify:
    # Checks that don't need to compile things
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
    - name: Checkout
      uses: actions/checkout@v4
    - name: Checkout SupportScripts
      uses: actions/checkout@v4
      with:
        repository: SpiNNakerManchester/SupportScripts
        path: support
    - name: Set C environment variables
      run: |
        echo "SPINN_DIRS=$PWD" >> $GITHUB_ENV
        echo "SPINN_PATH=$PWD/tools/boot" >> $GITHUB_ENV
        echo "PERL5LIB=$PWD/tools" >> $GITHUB_ENV
        echo "$PWD/tools" >> $GITHUB_PATH
    - name: "Lint sark code using Vera++"
      uses: ./support/actions/vera
      with:
        base-dir: sark
    - name: "Lint scamp code using Vera++"
      uses: ./support/actions/vera
      with:
        base-dir: scamp
        profile: spinnaker-asm
    - name: "Lint spin1_api code using Vera++"
      uses: ./support/actions/vera
      with:
        base-dir: spin1_api
    - name: "Lint apps code using Vera++"
      uses: ./support/actions/vera
      with:
        base-dir: apps
        options: -P max-line-length=200
    - name: "Lint bmp code using Vera++"
      uses: ./support/actions/vera
      with:
        base-dir: bmp
        profile: spinnaker-asm
        options: -P max-line-length=200
    - name: "Lint include code using Vera++"
      uses: ./support/actions/vera
      with:
        base-dir: include
        options: -P max-line-length=200 -P max-file-length=3000
    - name: Run rat copyright enforcement
      uses: ./support/actions/check-copyrights
      with:
        config_file: rat_asl20.xml
    - name: Build documentation using doxygen
      run: |
        sudo apt-get -q install doxygen --fix-missing
        make doxygen

    - name: Validate CITATION.cff
      uses: dieghernan/cff-validator@main