mirror of
https://github.com/iiab/iiab.git
synced 2025-02-14 12:12:12 +00:00
Update roles-needing-docs.py
This commit is contained in:
parent
f915b5ee22
commit
4b43f46530
1 changed files with 6 additions and 4 deletions
|
@ -1,9 +1,9 @@
|
||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
|
|
||||||
'''
|
'''
|
||||||
This script checks every role in the project and prints its name to stdout if
|
This script checks every role in the (Internet-in-a-Box) project and prints its
|
||||||
the role directory does not contain a README file and it is not listed in
|
name to stdout if (1) the role directory does not contain a README file, and
|
||||||
scripts/docs-ignore.
|
(2) the role is not listed in /opt/iiab/iiab/unmaintained-roles.txt
|
||||||
|
|
||||||
For ease of use, you can pipe the output of this script to a file or to a
|
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).
|
clipboard utility (e.g. pbcopy on macOS, xclip on Linux).
|
||||||
|
@ -16,7 +16,9 @@ from glob import glob
|
||||||
def included_roles():
|
def included_roles():
|
||||||
all_roles = set(os.listdir("/opt/iiab/iiab/roles"))
|
all_roles = set(os.listdir("/opt/iiab/iiab/roles"))
|
||||||
excluded_roles = \
|
excluded_roles = \
|
||||||
map(str.rstrip, open(make_path("/opt/iiab/iiab/scripts", "/opt/iiab/iiab/scripts/docs-ignore")))
|
map(str.rstrip,
|
||||||
|
open(make_path("/opt/iiab/iiab/scripts",
|
||||||
|
"/opt/iiab/iiab/unmaintained-roles.txt")))
|
||||||
included_roles = list(all_roles.difference(excluded_roles))
|
included_roles = list(all_roles.difference(excluded_roles))
|
||||||
included_roles.sort()
|
included_roles.sort()
|
||||||
return included_roles
|
return included_roles
|
||||||
|
|
Loading…
Reference in a new issue