simply static deploy

Implementación simplemente estática

Este repositorio está archivado.

❗️ GRRR ya no mantiene este complemento.

Recomendamos utilizar el plan Pro del complemento Simply Static. Cuando iniciamos este complemento, solucionó la falta de una función de implementación en Simply Static. Desde entonces, el complemento se actualizó y el plan Pro ofrece exactamente lo que nos faltaba.
GRRR ha contribuido con código y funciones al complemento Simply Static y estamos felices de verlo crecer.
Te sugerimos echarle un vistazo, vale la pena la inversión.

¡Gracias a todos los que se han interesado en este complemento!
Si ha disfrutado usando este complemento o se ha inspirado en él de alguna manera, tal vez le gustaría seguir nuestro blog, donde escribimos sobre nuestro trabajo y las cosas que aprendemos a lo largo del camino: grrr.tech.

---

Implemente sitios estáticos fácilmente en un depósito de AWS S3

• Utiliza el excelente complemento Simply Static para la generación de sitios estáticos.
• Agrega implementación al almacenamiento compatible con S3 (AWS S3, DigitalOcean Spaces, ...).
• Agrega un paso opcional de invalidación de CDN de CloudFront.
• Los pasos se pueden activar a través de una interfaz de usuario simple o mediante programación.
• Capacidad para generar e implementar una sola página, incluida la opción recursiva
• Personalizable mediante ganchos y acciones.

Desarrollado con ❤️ por GRRR

• GRRR es una empresa B
• GRRR tiene un blog de tecnología
• GRRR está contratando
• @GRRRTech tuits

Generar e implementar interfaz de usuario.

Interfaz de usuario de una sola página/despliegue posterior

Requisitos mínimos

Este complemento requiere:

• Una versión mínima de PHP 7.1 .
• Una versión instalada y activada del complemento Simply Static.

Instalación

Este complemento debe instalarse mediante Composer.

Asegúrese de tener configuradas las rutas de instalación correctas en su composer.json . Esto debe hacerse antes de solicitar el paquete:

 "extra" : {
  "installer-paths" : {
    "wp-content/plugins/{$name}/" : [ " type:wordpress-plugin " ]
  }
}

Instalar a través de Composer:

$ composer require grrr-amsterdam/simply-static-deploy

Si aún no estás utilizando Composer en tu proyecto, asegúrate de requerir el cargador automático de Composer. Un buen lugar sería en tu wp-config.php :

 /** Sets up WordPress vars and included files. */
require_once ABSPATH . ' vendor/autoload.php ' ; # ‹— add this
require_once ABSPATH . ' wp-settings.php ' ;

Uso

Primero define SIMPLY_STATIC_DEPLOY_CONFIG en tu configuración de WordPress:

 define ( ' SIMPLY_STATIC_DEPLOY_CONFIG ' , [
    ' aws ' => [
        ' key ' => ' ... ' , # AWS access key
        ' secret ' => ' ... ' , # AWS secret key
        ' region ' => ' ... ' , # AWS region
        ' bucket ' => ' ... ' , # S3 bucket
        ' bucket_acl ' => ' ... ' , # S3 bucket ACL (optional, defaults to `public-read`)
        ' distribution ' => ' ... ' , # CloudFront distribution ID (optional, step is skipped when empty)
        ' endpoint ' => ' ... ' , # For usage with providers other than AWS (optional)
    ],
    ' url ' => ' ... ' , # Website url (used for displaying url after deploy is finished)
]);

Luego configure el complemento Simply Static a través de la interfaz de administración. La configuración más importante para hacerlo bien es:

• Delivery Method : configurado en Local Directory (los archivos se sincronizan con S3, zip no funcionará)

Otras configuraciones a las que debes prestar atención:

• Additional URLs : agregue cualquier URL que el complemento no pueda encontrar
• Additional Files and Directories : agregue directorios adicionales (por ejemplo, activos de front-end)
• URLs to Exclude : por ejemplo, la carpeta de cargas (pero solo cuando descargas cargas en tiempo de ejecución)

Si todo está configurado correctamente, presione Generate & Deploy en la pestaña Deploy .

Documentación

Características

Implementación de una sola publicación

Las páginas/publicaciones vienen con un botón de implementación única, de modo que se puede generar e implementar una sola página; consulte la interfaz de usuario de implementación de una sola página/publicación.

Implementación recursiva única

También se puede realizar una implementación de una sola publicación o página de forma recursiva marcando la opción recursiva; consulte la casilla de verificación en la interfaz de usuario de implementación de una sola página o publicación. Cuando se haya marcado "recursivo", todas las páginas/publicaciones que contengan la URL de la página/publicación actual también se generarán e implementarán.

Filtros y acciones disponibles

Filtros disponibles para modificar la configuración y los datos pasados ​​al complemento:

• Ajustar archivos adicionales
• Ajustar archivos adicionales para implementación única
• Ajustar URL adicionales
• recursivo excluible

Acciones disponibles para invocar o actuar sobre:

• Manejar errores
• Trabajo de implementación estática completado
• Modificar archivos generados
• Programar implementaciones

Filtros

Ajustar archivos adicionales

Modifique las entradas desde la opción 'Archivos y directorios adicionales'. De forma predeterminada, todas las rutas se resuelven temporalmente en rutas absolutas a través de realpath, para garantizar que se resuelvan los enlaces simbólicos. Se pasa como argumento una serie de archivos no modificados de las opciones.

 add_filter ( ' simply_static_deploy_additional_files ' , function ( array $ files ) {
    # Modify files, and possibly resolve paths with `realpath`.
    return $ files ;
});

Nota: durante la generación del sitio estático, la configuración additional_files se actualiza. Se restaura cuando esté terminado.

Ajustar archivos adicionales para implementación única

Al realizar una implementación única, solo se generará la página/publicación dada, incluidos los archivos proporcionados en la configuración 'Archivos adicionales' de Simply Static. Puede cambiar estos archivos adicionales para implementaciones únicas a través del filtro simply_static_deploy_single_additional_files . Se necesitan dos argumentos: el primero es una matriz de nombres de archivos, el segundo es la instancia de Simply Static Options.

Ajustar URL adicionales

Modifique las entradas desde la opción 'URL adicionales'. Esto puede ser útil para agregar páginas que Simply Static no puede encontrar (no en el mapa del sitio, están excluidas por una contraseña, noindex tienen índice, etc.). Se pasa como argumento una serie de URL no modificadas de las opciones.

 add_filter ( ' simply_static_deploy_additional_urls ' , function ( array $ urls ) {
    # Modify urls, for example by adding missing pages.
    return $ urls ;
});

Nota: durante la generación del sitio estático, se actualiza la configuración additional_urls . Se restaura cuando está terminado.

Modificar recursivo excluible

Este filtro agrega la opción de personalizar la configuración de la URL excluible. Esto puede resultar útil cuando, por ejemplo, desea ignorar las exclusiones cuando una URL contiene la URL principal recursiva.

 add_filter ( ' simply_static_deploy_recursive_excludable ' , function (
    $ excludable ,
    string $ staticPageUrl ,
    string $ recursiveUrl
) {
    # Modify excludable url logic, for example ignore excludeable url setting when current page contains the recursiveUrl
    return $ excludable ;
});

Comportamiento

Manejar errores

Se llama desde el complemento y recibe un objeto WP_Error que explica el error. Puede decidir cómo manejar el error, por ejemplo, registrándolo en el servicio de su elección.

 add_action ( ' simply_static_deploy_error ' , function (  WP_Error $ error ) {
    # Handle the error.
});

Trabajo de implementación estática completado

Esto se activará una vez finalizadas todas las tareas de implementación. El primer y único argumento que obtendrá en la función de devolución de llamada es la instancia de opciones de Simply Static.

 add_action('simply_static_deploy_complete' , function (Simply_StaticOptions $options) {
    // Finished static deploy job.
});

Modificar archivos generados

Se llama cuando Simply Static termina de generar el sitio estático. Esto le permite modificar los archivos generados antes de implementarlos. El directorio del sitio estático se pasa como argumento.

 add_action ( ' simply_static_deploy_modify_generated_files ' , function (
    string $ directory
) {
    # Modify generated files, like renaming or moving them.
});

Programar implementaciones

Programe un evento de implementación.

Argumentos:

• Hora : debe ser una cadena de tiempo simple, se convierte automáticamente a una marca de tiempo UNIX en la zona horaria configurada de WordPress.
• Intervalo : los valores aceptados son hourly , twicedaily y daily . Se puede ampliar mediante cron_schedules.

 do_action ( ' simply_static_deploy_schedule ' , ' 12:00 ' , ' daily ' );

Nota: es importante que se llame a WP-Cron con regularidad. Puede hacerlo desactivando el mecanismo WP-Cron predeterminado y cambiando a llamarlo a través de un cronjob dedicado.

Para deshabilitar el WP–Cron predeterminado (que normalmente se llama cuando un usuario visita páginas), agregue lo siguiente a su configuración de WordPress:

 define ( ' DISABLE_WP_CRON ' , true );

Cree un cronjob llamando a WordPres WP-Cron. Configurarlo cada 5 minutos sería un buen valor predeterminado. Por ejemplo, mediante crontab -e en una máquina Linux:

 */5 * * * * curl https://example.com/wp/wp-cron.php?doing-cron > /dev/null 2>&1

Problemas comunes

 Fatal error: Uncaught Error: Class 'GrrrSimplyStaticDeploySimplyStaticDeploy' not found

Consulte las instrucciones de instalación y requiera el cargador automático Composer en su proyecto.