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:
    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 up Python 3.12
      # Note: Python is needed for spinn_utilities.make_tools when building
      uses: actions/setup-python@v4
      with:
        python-version: 3.12
    - name: Install Ubuntu dependencies
      uses: ./support/actions/apt-get-install
      with:
        packages: doxygen gcc-arm-none-eabi

    - name: Checkout SpiNNaker C Dependencies
      uses: ./support/actions/install-spinn-deps
      with:
        # Note: SpiNNUtils needed for spinn_utilities.make_tools
        repositories: spinnaker_tools spinn_common SpiNNFrontEndCommon
        install: false

    - name: "Prepare: Install SpiNNUtils"
      uses: ./support/actions/install-spinn-deps
      with:
        # Note: SpiNNUtils needed for spinn_utilities.make_tools
        repositories: SpiNNUtils
        install: true

    - name: Set environment variables
      run: |
        echo "SPINN_DIRS=$PWD/spinnaker_tools" >> $GITHUB_ENV
        echo "NEURAL_MODELLING_DIRS=$PWD/neural_modelling" >> $GITHUB_ENV

    - name: Lint C code using Vera++
      uses: ./support/actions/vera
      with:
        base-dir: neural_modelling/src

    - name: Build C dependencies
      run: |
        make -C $SPINN_DIRS
        make -C spinn_common install
        make -C SpiNNFrontEndCommon/c_common install

    - name: Build C code
      run: make
      working-directory: neural_modelling
      env:
        CFLAGS: -fdiagnostics-color=always

    - name: Build C code in DEBUG mode
      run: make clean; make SPYNNAKER_DEBUG=DEBUG
      working-directory: neural_modelling
      env:
        CFLAGS: -fdiagnostics-color=always

    - name: Build documentation using doxygen
      run: make doxysetup doxygen
      working-directory: neural_modelling