Caja de herramientas del desarrollador de Smart WordPress Actualizador de complementos GitHub

¿No quiere alojar su complemento en el Directorio de Complementos de WordPress.org? Por supuesto, puedes decidir no hacerlo, es una comunidad libre después de todo. Pero debe alojarlo en algún lugar para poder encontrar el complemento, y también debe proporcionar a sus usuarios actualizaciones de su complemento.. 

La mayoría de las personas que deciden no alojar sus complementos en WordPress.org tienden a usar GitHub, pero WordPress no sabe cómo actualizar los complementos alojados en GitHub; necesita ayuda. Y hoy, lo ayudaremos a ayudar a WordPress a actualizar sus complementos, lo ha adivinado, una clase de ayuda.

En esta parte de la serie "Caja de herramientas del Desarrollador inteligente de WordPress", veremos el actualizador de complementos de WordPress GitHub, una herramienta para manejar el proceso de actualización de los complementos de WordPress alojados en GitHub.

Por qué usar GitHub en lugar de WordPress.org?

Al igual que cualquier otro sistema de gestión de contenido modular, WordPress tiene su propio repositorio de complementos. Y no me equivocaría si dijera que el Directorio de Complementos de WordPress.org se ha convertido en el estándar de la comunidad para hospedar complementos de WordPress gratuitos y de código abierto..

Pero como dije al principio, esta es una comunidad libre. WordPress no nos exige que alojemos todos los complementos y temas que creamos en el Directorio de Complementos de WordPress.org. La gente puede elegir alejarse de eso, y eso es perfectamente natural..

El primer lugar donde las personas alojan sus complementos de WordPress después del Directorio de Complementos de WordPress.org es GitHub. Utilizando el increíble sistema de control de revisión llamado Git, GitHub es uno de los mejores lugares para compartir su software de código abierto con el resto del mundo. Y durante los últimos años, más y más desarrolladores de WordPress han estado publicando sus nuevos complementos en GitHub..

Ventajas y desventajas de cambiar del directorio de complementos de WordPress.org a GitHub

Creo que hay un equilibrio entre las ventajas y desventajas de alojar los complementos de WordPress en GitHub en lugar del Directorio de complementos de WordPress.org. Voy a describir los que me vienen a la mente, pero también me encantaría su opinión sobre esto, así que no dude en comentar un comentario en la sección de Comentarios después de leer esto..

Cuando alojas tus plugins en WordPress.org:

  • Tienes que usar SVN.
  • Su complemento debe ser aprobado por un revisor de WordPress.org antes de que pueda subirlo. (Esto es tanto una ventaja como una desventaja para mí, ya que tener un segundo conjunto de ojos en el código es bueno para detectar fallas de seguridad).
  • Solo puede usar GPL (versión 2 o posterior) como licencia.
  • Sus actualizaciones de plugin serán notificadas a sus usuarios rápidamente.
  • Las actualizaciones de los complementos de emergencia (por razones de seguridad) se enviarán automáticamente a los usuarios.
  • La gente puede encontrar su complemento directamente desde sus paneles de administración, lo que es una gran ventaja.
  • Puedes usar los foros de soporte de WordPress.org.

Y cuando decidas cambiar a GitHub:

  • Podrás usar Git.
  • Tendrás infinitamente más libertad..
  • Puede usar otros tipos de licencias (como MIT o CC, aunque CC no se recomienda para el software).
  • Puede crear una wiki, aceptar confirmaciones y hablar sobre problemas con sus usuarios.
  • No tendrá ninguna clasificación para sus complementos, lo que es malo para la retroalimentación..
  • Tendrá que terminar este tutorial para proporcionar actualizaciones de complementos más fácilmente.

También hay un buen debate sobre WordPress Tavern, que creo que también debería leer.

Integración del actualizador de complementos de WordPress GitHub en tu complemento

Listo para proporcionar notificaciones de actualización para sus usuarios?

Primero y obviamente, necesita descargar el Actualizador de complementos de WordPress GitHub desde su repositorio de GitHub. Solo necesitaras el updater.php Archivo, así que no te preocupes por los demás..

Después de eso, necesitas poner el updater.php archiva en algún lugar de tu carpeta de complementos e inclúyelo en tu complemento. Por ejemplo, si pones el updater.php archivo en una carpeta llamada github-plugin-updater y desea incluirlo en su archivo de complemento principal, debe agregar la siguiente línea a ese archivo:

También necesita inicializar el WP_GitHub_Updater Clase con los argumentos correctos para conectar tu complemento a tu repositorio de GitHub:

 plugin_basename (__FILE__), 'proper_folder_name' => 'plugin-name', 'api_url' => 'https://api.github.com/repos/username/repository-name', 'raw_url' => 'https: / /raw.github.com/username/repository-name/master ',' github_url '=>' https://github.com/username/repository-name ',' zip_url '=>' https://github.com / username / nombre del repositorio / zipball / master ',' sslverify '=> true,' require '=>' 3.0 ',' tested '=>' 3.3 ',' readme '=>' README.md ',' access_token '=> "); nuevo WP_GitHub_Updater ($ config);?>
  • babosa: La bala de tu plugin.
  • proper_folder_name: El nombre de la carpeta de tu plugin.
  • api_url: La URL de la API del repositorio de GitHub.
  • raw_url: La URL cruda de tu repositorio de GitHub.
  • github_url: La URL de tu repositorio de GitHub.
  • zip_url: La URL del ZIP de tu repositorio de GitHub.
  • sslverify: Ya sea para verificar SSL o no.
  • requiere: La versión mínima de WordPress que requiere tu plugin.
  • probado: La versión máxima de WordPress con la que probaste tu plugin.
  • readme (en desuso): el archivo README para verificar la versión del complemento desde.
  • access_token: Tu token de acceso de GitHub, si estás usando un repositorio privado.

Para notificar a sus usuarios, todo lo que tiene que hacer es cambiar la versión del complemento en los encabezados de su archivo principal. (Parece que esta herramienta se utiliza para comprobar el archivo README para una línea que contiene ~ Versión actual: X.X ~ pero a partir de la versión 1.6, primero busca el archivo principal del complemento.)

¡Y eso es! Siguiendo estos pasos habilitará las notificaciones de actualización para su complemento.

Envolviendo para hoy

Si desea alojar su complemento de WordPress en GitHub y desea proporcionar notificaciones de actualización para sus usuarios, el Actualizador de complementos de WordPress GitHub es una de las herramientas esenciales que debe utilizar.

¿Qué piensas acerca de esta herramienta, o el alojamiento de complementos de WordPress en GitHub en general? Comparta sus opiniones con nosotros comentando en la sección de Comentarios a continuación. Y si te gustó el artículo, no olvides compartirlo con tus amigos.!