mirror of
https://github.com/iiab/iiab.git
synced 2025-03-09 15:40:17 +00:00
Create script to check roles for missing documentation
This commit is contained in:
parent
44d2cfc0dd
commit
6a046ed789
1 changed files with 16 additions and 0 deletions
16
tests/check_role_docs.py
Executable file
16
tests/check_role_docs.py
Executable file
|
@ -0,0 +1,16 @@
|
|||
#!/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.
|
||||
|
||||
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, glob
|
||||
|
||||
for role in os.listdir("roles"):
|
||||
readme_glob = os.path.join("roles", role, "README.*")
|
||||
if not glob.glob(readme_glob):
|
||||
print(role)
|
Loading…
Add table
Reference in a new issue