Skip to content

Another pass at documentation and READMEs. #1294

Another pass at documentation and READMEs.

Another pass at documentation and READMEs. #1294

Workflow file for this run

name: CI Lint
on: [push, pull_request]
jobs:
clang-format:
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Run clang-format
uses: DoozyX/clang-format-lint-action@v0.14
with:
source: '.'
exclude: './simplepyble'
extensions: 'h,hpp,cpp,c'
clangFormatVersion: 14
inplace: False
cppcheck:
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Install CppCheck
run: |
sudo -H apt-get update -y
sudo -H apt-get install -y cppcheck
env:
DEBIAN_FRONTEND: noninteractive
- name: Run Cppcheck
# TODO: Fix the suppressed file.
run: cppcheck --suppress=objectIndex:simpleble/src/backends/windows/Utils.cpp --std=c++17 --error-exitcode=1 --xml --xml-version=2 --force . 2>cppcheck_res.xml
- name: Generate Report
if: ${{ failure() }}
run: cppcheck-htmlreport --title=SimpleBLE --file=cppcheck_res.xml --report-dir=report
- name: Upload Report
if: ${{ failure() }}
uses: actions/upload-artifact@v3
with:
name: report
path: report