24 lines
779 B
Bash
Executable File
24 lines
779 B
Bash
Executable File
#!/bin/sh
|
|
set -eu
|
|
|
|
repo=$(CDPATH= cd -- "$(dirname "$0")/.." && pwd)
|
|
readme="$repo/README.md"
|
|
|
|
test -s "$readme"
|
|
for text in \
|
|
'## Install' 'go install ./cmd/proxyctl' '## First use and Profiles' \
|
|
'## Shell integration' 'Shell' 'APT' 'Docker daemon' \
|
|
'Docker containers/builds' 'GNOME' '## Target states' 'Enabled' \
|
|
'Disabled' 'External' 'Drifted' '## Permissions, sudo, and restarts' \
|
|
'proxyctl doctor' 'proxyctl reset' 'proxyctl shell uninstall' \
|
|
'no telemetry' 'automatic update checks' 'proxy-connectivity tests' \
|
|
'does **not** manage or supervise proxy processes' 'Support is limited'
|
|
do
|
|
grep -Fq "$text" "$readme" || {
|
|
echo "README is missing required documentation: $text" >&2
|
|
exit 1
|
|
}
|
|
done
|
|
|
|
printf 'README documentation contract passed\n'
|