mirror of
				https://github.com/iiab/iiab.git
				synced 2025-03-09 15:40:17 +00:00 
			
		
		
		
	Update and rename roles_needing_docs.py to roles-needing-docs.py
This commit is contained in:
		
							parent
							
								
									d452d1c08f
								
							
						
					
					
						commit
						f915b5ee22
					
				
					 1 changed files with 4 additions and 4 deletions
				
			
		
							
								
								
									
										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("/opt/iiab/iiab/roles"))
 | 
			
		||||
    excluded_roles = \
 | 
			
		||||
        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("/opt/iiab/iiab/roles", role, "README.*")
 | 
			
		||||
    if not glob(readme):
 | 
			
		||||
        print(role)
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue