generate-installation-instructions

Breve: script CLI que analiza ./customizations/deploy.xml, genera una tabla de objetos/archivos y puede (1) escribir un Excel y/o (2) copiar una tabla Markdown al portapapeles.

Requisitos

• Node.js >= 16 (proyecto usa ESM y dependencias recientes)
• git (opcional, usado para obtener commit/branch)

Instalación

Instalación global (desde npm)

npm i -g generate-installation-instructions

Uso

El paquete expone el comando generate-installation-instructions cuando está instalado globalmente.

Opciones principales:

• -clip, --clip : Copia al portapapeles una tabla Markdown con las columnas: TYPE, NAME, FILE/ID, IS NEW?, NOTES (OPTIONAL). Las celdas se envuelven en formato monoespacio para evitar romper la tabla. Puedes copiar este formato en un documento de Confluence para obtener la tabla completa.
• -x, --excel : Genera un archivo Excel con la tabla (por defecto: ./customizations/deploymentInstructions.xlsx). Puedes abrir el archivo excel, copiar las filas y pegarlas en una tabla existente en un documento de confluence.

Ejemplos:

generate-installation-instructions -clip
generate-installation-instructions --excel

Formato de salida (Markdown)

La tabla tiene este encabezado (ejemplo):

| TYPE | NAME | FILE/ID | IS NEW? | NOTES (OPTIONAL) |
| --- | --- | --- | --- | --- |
| `Custom Record` | `MyRecord` | `customrecord_myrecord.xml` |  |  |

Cómo los usuarios obtienen la actualización:

• Si instalaron desde npm: npm update -g generate-installation-instructions o npm i -g generate-installation-instructions@latest.

Troubleshooting rápido

• Si git falla para obtener commit/branch, instala git o ejecuta el comando desde un repo git.

Contribuir

Los archivos que no se reconozcan aparecen como 'unknown - filetype', si quieres apoyar a agregar este nuevo tipo, enviame un mensaje con el tipo de documento, por ejemplo 'advancedpdftemplate', y de donde se obtiene el nombre 'name', 'title', 'label', etc.