Validate that all options are documented & Document missing settings (#1847)

* gha: Validate that all options are documented

* Document missing settings
This commit is contained in:
Constantin Piber
2026-01-11 22:47:26 +01:00
committed by GitHub
parent f8bee14808
commit 3c518707eb
2 changed files with 39 additions and 0 deletions

View File

@@ -95,3 +95,26 @@ jobs:
exit "$ecode"
fi
exit 0
check_docs:
name: Validate that all options are documented
runs-on: ubuntu-latest
steps:
- name: Clone repo
uses: actions/checkout@v6
- name: Validate all options are documented
run: |
f="`cat ./server/server-config/src/main/kotlin/suwayomi/tachidesk/server/ServerConfig.kt |
awk -F' ' 'BEGIN{prev=""}{if ($3 ~ "Mutable" && !(prev ~ "@Deprecated")) print "server." substr($2, 1, length($2)-1); prev=$0}' |
while read -r setting; do
if ! grep "$setting" ./docs/Configuring-SuwayomiServer.md >/dev/null; then
echo "Setting $setting not documented" >&2
echo ":"
fi
done`"
if [ -n "$f" ]; then
exit 1
fi