mirror of
https://github.com/nodemcu/nodemcu-firmware.git
synced 2025-01-30 21:12:55 +08:00
Add CI check to verify MkDocs menu items (#3367)
This commit is contained in:
parent
c4aaa9e0a7
commit
53fc7170bd
16
.github/workflows/build.yml
vendored
16
.github/workflows/build.yml
vendored
@ -240,3 +240,19 @@ jobs:
|
||||
./tools/travis/run-luacheck-${{ matrix.os }}.sh
|
||||
shell: bash
|
||||
|
||||
|
||||
|
||||
doc_check:
|
||||
|
||||
strategy:
|
||||
fail-fast: false
|
||||
runs-on: ubuntu-16.04
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
with:
|
||||
submodules: false
|
||||
- name: all_modules_linked
|
||||
run: ./tools/check_docs_module_linkage.sh
|
||||
shell: bash
|
||||
|
||||
|
10
tools/check_docs_module_linkage.sh
Executable file
10
tools/check_docs_module_linkage.sh
Executable file
@ -0,0 +1,10 @@
|
||||
#!/bin/bash
|
||||
|
||||
# get all linked module docs for mkdocs.yml
|
||||
grep "modules/" mkdocs.yml | sed "s/ *- .*: *'//" | sed "s/'//" | sort > /tmp/doc
|
||||
|
||||
# get all module and lua_module *.md files
|
||||
find docs/modules/ docs/lua-modules/ -name "*.md" | sed "sxdocs/xx" | sort > /tmp/files
|
||||
|
||||
diff /tmp/doc /tmp/files && echo "all *.md files are reflected in mkdocs.yml"
|
||||
|
Loading…
x
Reference in New Issue
Block a user