Contexto de organización

Los comandos pwd, repos, clone y exit tienen el mismo comportamiento que en el contexto principal.

Además, en el caso del comando clone, se creará una carpeta con el nombre de la organización en la que nos encontremos y en ella se guardarán todos los repositorios clonados.

• Mostrar la ayuda. Comando help.

  			ghshell > help
  

  En función del contexto donde nos encontremos, se mostrarán diferentes opciones en la ayuda.

  Figura: Ayuda en el contexto de organización

  

• Salir del contexto actual. Comando back.

  			ghshell > back
  

  Si nos encontramos en un repositorio propio o en una organización, regresamos al contexto principal. Si nos encontramos dentro de un repositorio de una organización, regresamos al contexto de la organización.

  Figura: Regreso al contexto principal desde una organización

  

  Figura B.21: Regreso al contexto principal desde un repositorio

  

• Ejecutar un script determinado. Comando script.

  			ghshell > script <file> /regexp/
  

  Este comando sirve para ejecutar un script. La ruta del fichero del script puede ser absoluta o relativa.

  
  

  El script debe estar escrito en Bash.

  Al especificar una expresión regular, se ejecutará el script en todos los repositorios que coincidan con la expresión regular indicada.

  Figura: Ejecución de script en repositorios que coinciden con la regexp pasada

  

  La ejecución de cada script se ejecuta en un proceso hijo independiente pero, a diferencia del clonado, el script se ejecuta línea a línea de manera síncrona.

  
  

  Se puede observar el estado de la ejecución del script y los resultados revisando el fichero de log que se genera:

  
  <nombre-repositorio>-<nombre-script>.log

  Figura: Fichero de log generado resultante de la ejecución del script

  

• Exportar resultados. Comando book.

  			ghshell > book string | /regexp/
  

  Este comando genera un Gitbook con los resultados de todos los scripts ejecutados sobre los repositorios. Este libro se genera en formato PDF y en HTML.

  
  

  Al especificar un string o expresión regular, se creará el libro por cada repositorios que coincida con la expresión regular indicada.

  Figura: Creación del Gitbook en repositorios que coinciden con la regexp pasada

  

  La creación del libro se realiza de manera asíncrona, por lo que se puede seguir trabajando mientras se genera.

  
  

  Se puede observar el estado de la creación del libro y su exportación a PDF revisando los ficheros de logs que se generan:

  
  

  <nombre-repositorio>-gitbook_build.out y

  
  

  <nombre-repositorio>-gitbook_pdf.out.

  
  

  
  

  Tanto el PDF como el HTML contará con las siguientes páginas:

  • Índice (Tabla de contenidos).
  • Introducción: en esta página se copiará el fichero README.md del repositorio. En caso de que no tuviera ese fichero, se imprimirá un mensaje que indica que el repositorio no tiene fichero README.md.
  • Páginas correspondientes a la ejecución de cada script.

  La carpeta que contiene el libro en HTML se llamará:

  
  

  <nombre-repositorio>_gitbook/_book.

  Figura: Localización del HTML del Gitbook

  

  
  

  Para visualizar el libro en formato HTML, basta con ejecutar el comando:

  		[~]$ gitbook serve
  

  Se arrancará un servidor web y, accediendo a la página que nos indique la consola, se podrá leer el libro:

  Figura B.26: Visualizar libro en HTML (I)

  

  Figura B.27: Visualizar libro en HTML (II)

  

  El fichero PDF generado se llamará <nombre-repositorio>.pdf.

  Figura B.28: Indice del PDF generado

  

  Figura: Introducción del PDF generado

  

  Figura B.30: Resultado del clonado del repositorio

  

  Figura: Resultado de la ejecución del script en el repositorio

  

• Seleccionar assignments. Comando assignments.

  			ghshell > assignments string | /regexp/ [clone|book|script <file>]
  

  Los assignments son tratados como un caso especial de repositorios dentro de una organización.

  Si sólo se pasa como argumento un string o una expresión regular, listará los assignments que coincidan con dicho argumento.

  Figura: Assignments que coinciden con la expresión regular

  

  En el caso de que además se pase alguno de los parámetros: clone, script <file> o book; se clonará, se ejecutará un script o se creará un libro respectivamente en los repositorios que coincidan con el string o la expresión regular.

  
  

  Además, en el caso del comando clone, se creará una carpeta con el nombre de la asignación que contendrá todas las asignaciones clonadas.

  Figura: Clonado de asignaciones que coinciden con la expresión regular

  

  Figura: Ejecución de script en assignments que coinciden con la expresión regular

  

  Figura: Creación del Gitbook en los assignments que coinciden con la expresión regular

  

  Figura B.36: Directorios y ficheros generados