lint.yml

# Copyright 2022 ETH Zurich and University of Bologna.
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
# SPDX-License-Identifier: Apache-2.0

name: lint

on: [ push, pull_request, workflow_dispatch ]

jobs:

  lint-license:
    runs-on: ubuntu-latest
    steps:
    -
      name: Checkout
      uses: actions/checkout@v3
    -
      name: Check license
      uses: pulp-platform/pulp-actions/lint-license@v2
      with:
        license: |
          Copyright (\d{4}(-\d{4})?\s)?.*
          (Solderpad Hardware License, Version 0.51|Licensed under the Apache License, Version 2.0), see LICENSE for details.
          SPDX-License-Identifier: (SHL-0.51|Apache-2.0)
        # Exclude generated headers (no license checker support for optional lines)
        exclude_paths: |
          sw/utils/tinyprintf.h
          sw/inc/*
          *.md
          *.do
          *.lock
          LICENSE*

  lint-sv:
    runs-on: ubuntu-latest
    steps:
    -
      name: Checkout
      uses: actions/checkout@v3
    -
      name: Run Verible
      uses: chipsalliance/verible-linter-action@main
      with:
        paths: rtl
        exclude_paths: |
          rtl/redmule_noncomp.sv
          rtl/redmule_fma.sv
        extra_args: "--waiver_files .github/verible.waiver"
        github_token: ${{ secrets.GITHUB_TOKEN }}
        fail_on_error: true
        reviewdog_reporter: github-check

  lint-cxx:
      runs-on: ubuntu-latest
      steps:
      -
        name: Checkout
        uses: actions/checkout@v3
      -
        name: Run Clang-format
        uses: DoozyX/clang-format-lint-action@v0.14
        with:
          extensions: 'c,h,cpp'
          clangFormatVersion: 14
          style: >
            {
            IndentWidth: 2,
            ColumnLimit: 100,
            AlignEscapedNewlines: DontAlign,
            SortIncludes: false,
            AllowShortFunctionsOnASingleLine: true,
            AllowShortIfStatementsOnASingleLine: true,
            AllowShortLoopsOnASingleLine: true
            }
          exclude: |
            ./sw/inc/*
            ./sw/utils/tinyprintf.h