Docs: enable readthedocs rendering (for PRs) #197
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# SPDX-License-Identifier: BSD-3-Clause | |
# Copyright (c) 2020 STMicroelectronics | |
name: libmetal compliance checks | |
on: | |
pull_request: | |
branches: [ main ] | |
paths-ignore: | |
- docs/** | |
- cmake/** | |
- scripts/** | |
jobs: | |
compliance_review: | |
name: compliance review | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout the code | |
uses: actions/checkout@v3 | |
with: | |
ref: ${{ github.event.pull_request.head.sha }} | |
fetch-depth: 0 | |
- name: Install python dependencies | |
run: | | |
pip3 install setuptools | |
pip3 install python-magic junitparser gitlint codespell lxml | |
- name: Run Compliance Tests | |
continue-on-error: true | |
id: compliance | |
env: | |
BASE_REF: ${{ github.base_ref }} | |
run: | | |
export PATH=$PATH:~/.local/bin | |
export PROJECT_BASE=$PWD | |
git config --global user.email "you@example.com" | |
git config --global user.name "Your Name" | |
git rebase origin/${BASE_REF} | |
git log --pretty=oneline | head -n 10 | |
./scripts/ci/check_compliance.py --annotate -c origin/${BASE_REF}.. | |
- name: upload-results | |
uses: actions/upload-artifact@main | |
continue-on-error: True | |
with: | |
name: compliance.xml | |
path: compliance.xml | |
- name: check-warns | |
run: | | |
if [[ ! -s "compliance.xml" ]]; then | |
exit 1; | |
fi | |
files=($(./scripts/ci/check_compliance.py -l)) | |
for file in "${files[@]}"; do | |
f="${file}.txt" | |
if [[ -s $f ]]; then | |
errors=$(cat $f) | |
errors="${errors//'%'/'%25'}" | |
errors="${errors//$'\n'/'%0A'}" | |
errors="${errors//$'\r'/'%0D'}" | |
echo "::error file=${f}::$errors" | |
exit=1 | |
fi | |
done | |
if [ "${exit}" == "1" ]; then | |
exit 1; | |
fi |