mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-31 19:28:35 +00:00
f80f31eb0d
Rather than doing a doc build on every PR, limit it to PRs that either touch a file in doc/, *.rst and what's listed as DOXY_SOURCES in doc/CMakeLists.txt. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
73 lines
1.7 KiB
YAML
73 lines
1.7 KiB
YAML
# Copyright (c) 2020 Linaro Limited.
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
name: Documentation GitHub Workflow
|
|
|
|
on:
|
|
pull_request:
|
|
paths:
|
|
- 'doc/**'
|
|
- '**.rst'
|
|
- 'include/**'
|
|
- 'kernel/include/kernel_arch_interface.h'
|
|
- 'lib/libc/**'
|
|
- 'subsys/testsuite/ztest/include/**'
|
|
- 'tests/**'
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- name: Update PATH for west
|
|
run: |
|
|
echo "::add-path::$HOME/.local/bin"
|
|
|
|
- name: checkout
|
|
uses: actions/checkout@v2
|
|
|
|
- name: install-pkgs
|
|
run: |
|
|
sudo apt-get install -y ninja-build doxygen
|
|
|
|
- name: cache-pip
|
|
uses: actions/cache@v1
|
|
with:
|
|
path: ~/.cache/pip
|
|
key: ${{ runner.os }}-doc-pip
|
|
|
|
- name: install-pip
|
|
run: |
|
|
pip3 install setuptools
|
|
pip3 install -r scripts/requirements-base.txt
|
|
pip3 install -r scripts/requirements-doc.txt
|
|
|
|
- name: west setup
|
|
run: |
|
|
west init -l . || true
|
|
|
|
- name: build-docs
|
|
run: |
|
|
source zephyr-env.sh
|
|
make htmldocs
|
|
tar cvf htmldocs.tar --directory=./doc/_build html
|
|
|
|
- name: upload-build
|
|
uses: actions/upload-artifact@master
|
|
continue-on-error: True
|
|
with:
|
|
name: htmldocs.tar
|
|
path: htmldocs.tar
|
|
|
|
- name: check-warns
|
|
run: |
|
|
if [ -s doc/_build/doc.warnings ]; then
|
|
docwarn=$(cat doc/_build/doc.warnings)
|
|
docwarn="${docwarn//'%'/'%25'}"
|
|
docwarn="${docwarn//$'\n'/'%0A'}"
|
|
docwarn="${docwarn//$'\r'/'%0D'}"
|
|
# We treat doc warnings as errors
|
|
echo "::error file=doc.warnings::$docwarn"
|
|
exit 1
|
|
fi
|