mirror of
https://github.com/iiab/iiab.git
synced 2025-03-09 15:40:17 +00:00
Merge pull request #1201 from aidan-fitz/check-docs
Create script to check roles for missing documentation
This commit is contained in:
commit
97659636f3
2 changed files with 38 additions and 0 deletions
11
scripts/docs_ignore
Normal file
11
scripts/docs_ignore
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
authserver
|
||||||
|
debian_schooltool
|
||||||
|
ejabberd_xs
|
||||||
|
idmgr
|
||||||
|
ajenti
|
||||||
|
moodle-1.9
|
||||||
|
pathagar
|
||||||
|
schooltool
|
||||||
|
nodogsplash
|
||||||
|
docker
|
||||||
|
sugar-stats
|
27
scripts/roles_needing_docs.py
Executable file
27
scripts/roles_needing_docs.py
Executable file
|
@ -0,0 +1,27 @@
|
||||||
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
|
'''
|
||||||
|
This script checks every role in the project and prints its name to stdout if
|
||||||
|
the role directory does not contain a README file and it is not listed in
|
||||||
|
scripts/docs_ignore.
|
||||||
|
|
||||||
|
For ease of use, you can pipe the output of this script to a file or to a
|
||||||
|
clipboard utility (e.g. pbcopy on macOS, xclip on Linux).
|
||||||
|
'''
|
||||||
|
|
||||||
|
import os
|
||||||
|
from os.path import join as make_path
|
||||||
|
from glob import glob
|
||||||
|
|
||||||
|
def included_roles():
|
||||||
|
all_roles = set(os.listdir("roles"))
|
||||||
|
excluded_roles = \
|
||||||
|
map(str.rstrip, open(make_path("scripts", "docs_ignore")))
|
||||||
|
included_roles = list(all_roles.difference(excluded_roles))
|
||||||
|
included_roles.sort()
|
||||||
|
return included_roles
|
||||||
|
|
||||||
|
for role in included_roles():
|
||||||
|
readme = make_path("roles", role, "README.*")
|
||||||
|
if not glob(readme):
|
||||||
|
print(role)
|
Loading…
Add table
Add a link
Reference in a new issue