mirror of
https://github.com/Suwayomi/Tachidesk.git
synced 2026-01-27 05:54:13 +01:00
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:
23
.github/workflows/build_pull_request.yml
vendored
23
.github/workflows/build_pull_request.yml
vendored
@@ -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-Suwayomi‐Server.md >/dev/null; then
|
||||
echo "Setting $setting not documented" >&2
|
||||
echo ":"
|
||||
fi
|
||||
done`"
|
||||
if [ -n "$f" ]; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
|
||||
Reference in New Issue
Block a user