Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
ruanhaishen
Nodemcu Firmware
Commits
53fc7170
Unverified
Commit
53fc7170
authored
Jan 08, 2021
by
Gregor Hartmann
Committed by
GitHub
Jan 08, 2021
Browse files
Add CI check to verify MkDocs menu items (#3367)
parent
c4aaa9e0
Changes
2
Hide whitespace changes
Inline
Side-by-side
.github/workflows/build.yml
View file @
53fc7170
...
@@ -240,3 +240,19 @@ jobs:
...
@@ -240,3 +240,19 @@ jobs:
./tools/travis/run-luacheck-${{ matrix.os }}.sh
./tools/travis/run-luacheck-${{ matrix.os }}.sh
shell
:
bash
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
tools/check_docs_module_linkage.sh
0 → 100755
View file @
53fc7170
#!/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"
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment