diff --git a/scripts/roles-needing-docs.py b/scripts/roles-needing-docs.py new file mode 100755 index 000000000..9a2173c53 --- /dev/null +++ b/scripts/roles-needing-docs.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python3 + +''' +This script checks every role in the (Internet-in-a-Box) project and prints its +name to stdout if (1) the role directory does not contain a README file, and +(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 +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("/opt/iiab/iiab/roles")) + excluded_roles = \ + 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.sort() + return included_roles + +for role in included_roles(): + readme = make_path("/opt/iiab/iiab/roles", role, "README.*") + if not glob(readme): + print(role) diff --git a/scripts/roles_needing_docs.py b/scripts/roles_needing_docs.py deleted file mode 100755 index 5a814bb94..000000000 --- a/scripts/roles_needing_docs.py +++ /dev/null @@ -1,27 +0,0 @@ -#!/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) diff --git a/scripts/docs_ignore b/unmaintained-roles.txt similarity index 100% rename from scripts/docs_ignore rename to unmaintained-roles.txt index d41d794ad..350089e5d 100644 --- a/scripts/docs_ignore +++ b/unmaintained-roles.txt @@ -1,11 +1,11 @@ +ajenti authserver debian_schooltool +docker ejabberd_xs idmgr -ajenti moodle-1.9 +nodogsplash pathagar schooltool -nodogsplash -docker sugar-stats