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@v3
    - name: Checkout SupportScripts
      uses: actions/checkout@v3
      with:
        repository: SpiNNakerManchester/SupportScripts
        path: support

    - name: Install cross-compiler
      uses: ./support/actions/apt-get-install
      with:
        packages: gcc-arm-none-eabi
    - name: Checkout SpiNNaker Dependencies
      uses: ./support/actions/install-spinn-deps
      with:
        repositories: spinnaker_tools

    - name: Build dependency libraries
      run: |
        make -C spinnaker_tools/sark
        make -C spinnaker_tools/spin1_api
        make sllt.tag
      env:
        SPINN_DIRS: ${{ github.workspace }}/spinnaker_tools

    - name: Build C code
      run: make all install
      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
        SPINN_DIRS: ${{ github.workspace }}/spinnaker_tools

  verify:
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
    - name: Checkout
      uses: actions/checkout@v3
    - name: Checkout SupportScripts
      uses: actions/checkout@v3
      with:
        repository: SpiNNakerManchester/SupportScripts
        path: support

    - name: Install cross-compiler
      uses: ./support/actions/apt-get-install
      with:
        packages: doxygen
    - name: Checkout SpiNNaker Dependencies
      uses: ./support/actions/install-spinn-deps
      with:
        repositories: spinnaker_tools

    - name: "Check: Lint include code using Vera++"
      uses: ./support/actions/vera
      with:
        base-dir: include
        options: -P max-line-length=2500
    - name: "Check: Lint source code using Vera++"
      uses: ./support/actions/vera
      with:
        base-dir: src

    - name: Run rat copyright enforcement
      uses: ./support/actions/check-copyrights
      with:
        config_file: rat_asl20.xml

    - name: Build documentation using doxygen
      run: make doxygen
      env:
        SPINN_DIRS: ${{ github.workspace }}/spinnaker_tools

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