samykabu/github-wiki-publish

Publicación en Wiki de GitHub

Publica el material solicitado en el Wiki existente del repositorio. Mantén la generación de contenido separada de la publicación: utiliza las páginas, informes y recursos proporcionados, adaptando enlaces y navegación según sea necesario. Sigue las reglas del proyecto de destino sin importar convenciones de otro proyecto.

Establecer el destino y el alcance

• Resuelve el host de GitHub, el repositorio, la URL del Wiki, los archivos fuente y los nombres de página previstos a partir del contexto de la solicitud y del repositorio. Pregunta solo sobre opciones no resueltas que cambien materialmente la publicación.
• Distingue la preparación de la publicación. Una solicitud explícita de publicar autoriza la actualización del Wiki nombrado; no vuelvas a preguntar por la misma acción. Una solicitud de borrador o evaluación por sí sola no autoriza un push.
• Descubre primero las capacidades del conector relevante. Si no puede manejar adecuadamente el contenido y los recursos del Wiki, utiliza el repositorio Git separado del Wiki. Explica brevemente la alternativa. Las API ordinarias de Contenidos del repositorio no abordan el repositorio del Wiki.
• Verifica el acceso utilizando la conexión autenticada existente o las credenciales Git. Nunca incrustes credenciales en URL, páginas o evidencia retenida. Un 404 no autenticado no prueba que un Wiki privado esté ausente.
• Si no existe un repositorio Git del Wiki, comprueba si el Wiki está deshabilitado o necesita que se cree su primera página a través de GitHub. No habilites funciones del repositorio ni alteres el acceso como efecto secundario. Utiliza la creación autorizada de la primera página cuando sea posible; de lo contrario, informa del requisito previo faltante específico.

Preparar una actualización acotada

Para publicación mediante Git, lee el procedimiento Git. Utiliza un clon limpio temporal, descubre su rama predeterminada real y lee las páginas de destino existentes, Inicio y barra lateral antes de escribir.

• Asigna cada archivo fuente a una página o recurso de destino. Conserva las páginas no relacionadas, las secciones escritas a mano y la navegación. Un archivo fuente ausente no es una instrucción de eliminación. Reemplaza una página completa solo cuando pertenezca a la actualización solicitada; utiliza una edición limitada para contenido compartido de Inicio/barra lateral. Mantén los enlaces existentes y evita entradas de navegación duplicadas en ejecuciones repetidas.
• Lee y escribe texto explícitamente como UTF-8. Copia los recursos binarios byte a byte. No repares silenciosamente hechos fuente ni refresques un informe desde un conjunto de datos diferente. Conserva su fecha real, procedencia y limitaciones; utiliza el generador ascendente apropiado solo si la regeneración está dentro del alcance.
• Reescribe los enlaces para el destino real del Wiki. Los enlaces relativos al repositorio pueden romperse después de mover una página. Copia los recursos referenciados o enlaza a una revisión accesible del repositorio; no dejes rutas locales, enlaces a ramas no publicadas ni recursos externos inaccesibles.
• El Wiki muestra el nombre del archivo de la página como su título, por lo que una página que comienza con su propio H1 lo muestra dos veces. Elimina ese H1 y nombra la página después de él, manteniendo un H1 solo cuando difiere del nombre de la página a propósito (como Inicio); actualiza la navegación a los nombres derivados. Inicio se sirve en /wiki, por lo que sus enlaces relativos se resuelven fuera del Wiki: usa URLs absolutas del Wiki para imágenes, enlaces a páginas y la barra lateral.
• Utiliza imágenes en línea admitidas con texto alternativo significativo. Para un informe HTML o diagrama animado/interactivo, proporciona una vista previa estática útil y enlaces al artefacto original cuando el Wiki no pueda renderizarlo. No describas HTML descargable como una aplicación servida dentro del Wiki. Sigue las herramientas de diagrama específicas del proyecto al generar nuevo artefacto está dentro del alcance; ninguna habilidad requiere un generador en particular.
• Verifica los enlaces locales y recursos, el texto no ASCII representativo y las rutas exactas modificadas. Inspecciona el diff final en busca de eliminaciones no intencionadas, contenido sobrescrito, credenciales y residuos generados. Mantén los clones temporales y la evidencia local fuera del repositorio de la aplicación a menos que el usuario o el proyecto requieran fuentes retenidas allí.

Publicar y verificar

Aplica la publicación solo dentro de la autorización existente del usuario. Una actualización del Wiki no autoriza hacer push a una rama de la aplicación, modificar issues, desplegar un sitio, programar sincronización ni instalar CI.

• Confirma solo las rutas del Wiki previstas, luego obtén y reconcilia los cambios concurrentes como se describe en el procedimiento Git. Haz push normalmente a la rama predeterminada descubierta del Wiki. Nunca hagas force-push para superar a otro escritor.
• En caso de rechazo, obtén e inspecciona una vez. Integra ediciones compatibles y vuelve a verificar el diff completo. Si el mismo conflicto se repite, la intención no puede resolverse o el acceso falla, detén los reintentos y conserva el clon recuperable con un bloqueador preciso. No lo elimines en caso de fallo.
• Verifica el commit publicado contra el remoto en vivo. Un árbol de trabajo limpio por sí solo no prueba que los commits locales se hayan enviado.
• Inspecciona la página servida real a través de un navegador autenticado cuando esté disponible: texto de la página, Unicode representativo, navegación, enlaces, carga de imágenes y legibilidad. Para gráficos, compara el resultado renderizado con los datos fuente. Comprueba una imagen a tamaño completo cuando su vista previa en línea oculte etiquetas. Corrige los defectos observados dentro del alcance y vuelve a verificar el contenido afectado.
• Si la verificación renderizada autenticada no está disponible, informa de la publicación y la verificación remota por separado de la comprobación del navegador no ejecutada. No declares una verificación renderizada aprobada basada en archivos locales, una respuesta HTTP o un push exitoso.

Informa la URL de la página, la revisión publicada, los cambios materiales, las verificaciones realizadas y cualquier limitación no resuelta. Mantén las rutas de recuperación cuando el trabajo permanezca sin publicar. No añadas una nueva puerta de aprobación, esquema de contenido, ciclo de vida del proyecto o régimen de pruebas.