From f915b5ee224b3081dea8a28730f261c36aeb7cdc Mon Sep 17 00:00:00 2001 From: A Holt Date: Tue, 9 Oct 2018 14:57:23 -0400 Subject: [PATCH 1/3] Update and rename roles_needing_docs.py to roles-needing-docs.py --- scripts/{roles_needing_docs.py => roles-needing-docs.py} | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) rename scripts/{roles_needing_docs.py => roles-needing-docs.py} (71%) diff --git a/scripts/roles_needing_docs.py b/scripts/roles-needing-docs.py similarity index 71% rename from scripts/roles_needing_docs.py rename to scripts/roles-needing-docs.py index 5a814bb94..3d5a0aa83 100755 --- a/scripts/roles_needing_docs.py +++ b/scripts/roles-needing-docs.py @@ -3,7 +3,7 @@ ''' 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. +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). @@ -14,14 +14,14 @@ from os.path import join as make_path from glob import glob def included_roles(): - all_roles = set(os.listdir("roles")) + all_roles = set(os.listdir("/opt/iiab/iiab/roles")) excluded_roles = \ - map(str.rstrip, open(make_path("scripts", "docs_ignore"))) + map(str.rstrip, open(make_path("/opt/iiab/iiab/scripts", "/opt/iiab/iiab/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.*") + readme = make_path("/opt/iiab/iiab/roles", role, "README.*") if not glob(readme): print(role) From 4b43f4653085ad3d63b13c0af1435678d7e0ccb7 Mon Sep 17 00:00:00 2001 From: A Holt Date: Tue, 9 Oct 2018 15:10:23 -0400 Subject: [PATCH 2/3] Update roles-needing-docs.py --- scripts/roles-needing-docs.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/scripts/roles-needing-docs.py b/scripts/roles-needing-docs.py index 3d5a0aa83..9a2173c53 100755 --- a/scripts/roles-needing-docs.py +++ b/scripts/roles-needing-docs.py @@ -1,9 +1,9 @@ #!/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. +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). @@ -16,7 +16,9 @@ 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/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.sort() return included_roles From 7a890fd9b6c5f75c1f61aba3e16ab0c5770faee7 Mon Sep 17 00:00:00 2001 From: A Holt Date: Tue, 9 Oct 2018 15:13:14 -0400 Subject: [PATCH 3/3] Update and rename scripts/docs_ignore to unmaintained-roles.txt --- scripts/docs_ignore => unmaintained-roles.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) rename scripts/docs_ignore => unmaintained-roles.txt (100%) 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