Uso de Subversion con el directorio de complementos de WordPress

Siga estas instrucciones paso a paso para agregar y actualizar complementos en el directorio público de complementos de WordPress.

Estos pasos esenciales del video siguen a continuación:

• Primeros pasos con su complemento
• Regístrese para obtener una cuenta de WordPress.org
• Solicitud para colocar su nuevo complemento en el directorio de complementos de WordPress
• Instale un cliente SVN para su máquina
• Elija un directorio local para sus proyectos
• Su correo electrónico de aprobación de solicitud de complemento
• Términos del directorio para este artículo
• Tirando del nuevo directorio del servidor a su máquina local
• Termine de desarrollar su complemento
• Haga que su primera versión esté disponible para el público
  • Actualización del tronco del directorio del proyecto
  • Etiquetado de una nueva versión en el servidor
  • Actualización de su directorio de proyectos local con la nueva versión etiquetada
  • Actualización de la etiqueta estable readme.txt
• Nuevos desarrollos para su complemento

Primeros pasos con su complemento

Ya sea que solo tenga una idea o que esté a punto de terminar con la versión 0.1, necesita un nombre y una descripción para su complemento. Haga que el nombre sea corto y descriptivo, dando una idea de lo que hace el complemento. “Wax on Wax off Plugin” no es un buen nombre. "Drop Shadow Maker" es mucho mejor. No necesita agregar "Complemento" al título real.

Para ir junto con su título, debe escribir una breve descripción que le diga a la gente qué beneficios brinda su complemento. Recomiendo que esta descripción tenga menos de 150 caracteres.

Regístrese para obtener una cuenta de WordPress.org

Si aún no tiene una cuenta de WordPress.org, utilizada para interactuar en los foros de soporte y similares, debe obtener una. Simplemente vaya a: https://login.wordpress.org/register

Solicitud para colocar su nuevo complemento en el directorio de complementos de WordPress

La mayoría de los complementos razonables entregados con una licencia compatible pueden obtener espacio en el directorio de complementos de WordPress.

1. Vaya a: http://wordpress.org/extend/plugins/add/
2. Complete su Título y Descripción
   (¡Te dije que necesitarías eso!)
3. Omita la carga de su complemento desde este formulario, incluso si su complemento está listo para funcionar.

Su solicitud de directorio de complementos es procesada por personas reales, por lo que puede llevar un tiempo.

Instale un cliente SVN para su máquina

Para trabajar con el Directorio de Complementos, necesita un cliente Subversion en su máquina.

• Para Windows, recomiendo TortoiseSVN.
• Para Mac, parece que SCPlugin es un buen paquete.

Simplemente elija uno e instálelo. No hay mucho más que decir al respecto.

Elija un directorio local para sus proyectos

Subversion mantendrá una copia local de sus archivos de complementos actualizados con el directorio de complementos de WordPress. Recomiendo crear un directorio en su máquina local donde guardará todos sus proyectos rastreados por Subversion. Precaución: si tiene un entorno de desarrollo web en su máquina local, no caiga en la tentación de utilizar el directorio de complementos de WordPress de su servidor web local como directorio de su proyecto.

Por ejemplo, si tiene una instalación local de WordPress en su máquina donde se encuentra la carpeta de complementos:

documents/public_html/devdomain.com/wp-content/plugins/

… no creas que puedes usar ese directorio para sincronizar tus proyectos del directorio de complementos de WordPress. Eso te causará dolor.

En su lugar, cree un directorio como este ejemplo:

documents/projects/wp-plugins-public/

Cada una de sus carpetas de proyectos de complementos irá dentro de "wp-plugins-public". Para este tutorial, usaré una carpeta de complementos llamada "programador de contenido". Entonces, habré hecho un directorio como tal:

documents/projects/wp-plugins-public/content-scheduler

Su correo electrónico de aprobación de solicitud de complemento

Una vez que se haya aprobado su solicitud de complemento, recibirá un correo electrónico con un enlace a su repositorio SVN. Esto es específicamente para ese complemento, y es necesario para continuar con la sincronización de Subversion.

Términos del directorio para este artículo

Con tantos directorios, proyectos y carpetas diferentes mencionados en este artículo, podría ser fácil confundirse. Acordemos tres ubicaciones diferentes cuando trabajemos con este flujo de trabajo de Subversion.

1. Directorio de trabajo
   Esta es la copia actual del código que está cambiando y probando. Debe estar en la carpeta "/wp-content/plugins/" en su servidor web de desarrollo. En mi máquina, resulta ser:
   documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
2. Directorio de proyectos
   Este es el directorio que su cliente de Subversion mantendrá sincronizado con el directorio de complementos de WordPress. En mi máquina, esto es:
   documents/projects/wp-plugins-public/content-scheduler/
3. directorio del servidor
   Esto se refiere a su proyecto almacenado en el directorio de complementos de WordPress. Aquí es donde el público podrá obtener su complemento. La ubicación raíz se llama su "repositorio SVN" y se le asignará en su correo electrónico de aprobación de solicitud de complemento. Para mi ejemplo, esto es:
   http://plugins.svn.wordpress.org/content-scheduler

Tirando del nuevo directorio del servidor a su máquina local

Aunque no haya colocado ningún archivo en la ubicación de su nuevo complemento en el Directorio de complementos, debe bajar esa copia del directorio a su máquina. Al hacerlo, se establecen algunas banderas detrás de escena para ayudar a su cliente de Subversion a saber qué está actualizado y qué no.

1. Haga clic con el botón derecho en la carpeta del complemento del directorio de su proyecto.
2. Elija "Pagar SVN".
3. Ingrese su URL de repositorio SVN de WordPress (de su correo electrónico de aprobación) en el primer campo.
4. La carpeta del complemento del directorio de su proyecto debe estar en el segundo campo.
   Dado que comenzó este proceso haciendo clic con el botón derecho en esa carpeta, este campo ya debería estar completo.
5. Haga clic en Aceptar"

Termine de desarrollar su complemento

Desarrolle y pruebe su complemento. Esto incluye crear un archivo "readme.txt" adecuado para acompañarlo. El archivo "readme.txt" no son solo algunas notas aleatorias sobre su complemento. El directorio de complementos de WordPress utiliza el contenido del archivo "readme.txt" para comprender qué versión de su complemento se considera actual y también para crear el contenido de la página de su complemento en el directorio.

• Para obtener más información sobre cómo crear un archivo "readme.txt" adecuado, consulte este ejemplo de WordPress readme.txt.

Una parte esencial de su archivo "readme.txt" es la etiqueta "Estable". Mientras desarrolla su complemento, deje esta etiqueta como "troncal". Una vez que publique una versión para consumo público, la actualizaremos con el número de versión correcto.

Haga que su primera versión esté disponible para el público

Actualización del tronco del directorio del proyecto

1. Copie el contenido de su directorio de trabajo en la carpeta "troncal" de su directorio de proyecto.
   En mi caso, estoy copiando todo el contenido de mi complemento del directorio de trabajo:
   /documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
   a mi directorio de proyectos:
   /documents/projects/wp-plugins-public/content-scheduler/
2. Haga clic con el botón derecho en la carpeta del complemento "content-scheduler" en el directorio de su proyecto y elija "SVN Commit".
3. Ingrese un comentario para la confirmación si lo desea.
4. Revise la lista de archivos que se consideran nuevos y se copiarán en el servidor. Si esta lista parece correcta, haga clic en "Aceptar" y los archivos se copiarán en el directorio de su servidor en wordpress.org.

Etiquetado de una nueva versión en el servidor

Ha actualizado los archivos en "troncal", pero esto no es lo que el público debería descargar. Debe usar "etiquetado" para crear una copia de "troncal". Esta copia no se modificará más y se ofrecerá para uso público. Para este ejemplo, vamos a crear una versión 1.0.

1. Haga clic con el botón derecho en la carpeta "troncal" del directorio del proyecto y seleccione "Sucursal/Etiqueta".
   Para mi, esto es:
   /documents/projects/wp-plugins-public/content-scheduler/trunk/
2. El campo de ubicación "A la URL" terminará en "/troncal". Debe cambiar esto a "/tags/1.0" para crear su versión 1.0.
3. Puede agregar una nota sobre esta operación de etiquetado si lo desea.
4. Haga clic en "Aceptar" e ignore cualquier mensaje sobre "importante cambiar a esta rama..."

Actualización de su directorio de proyectos local con la nueva versión etiquetada

Acaba de decirle al servidor que haga una nueva copia de los archivos de su proyecto en el directorio "/tags/1.0". Ahora, necesitamos actualizar su directorio local de proyectos con esa nueva etiqueta.

Este proceso puede parecer extraño. Quizás se pregunte por qué no puede simplemente hacer su propia copia en su directorio local “/tags/1.0”. Si hace eso, el directorio del servidor y el directorio del proyecto pueden volverse desordenados y confusos acerca de lo que se actualiza y lo que no.

• Haga clic con el botón derecho en el directorio del proyecto nuevamente y elija "Actualización de SVN".
  Esto extrae los cambios del directorio del servidor a su directorio de proyecto local. En este caso, el cambio es una adición de la copia "/tags/1.0" de sus archivos.

Actualización de la etiqueta estable readme.txt

Todos los archivos correctos están en su lugar para que el público use su complemento. Sin embargo, tenemos que decirle al directorio de complementos qué versión etiquetada debe usar el público.

1. Edite el archivo "readme.txt" en la carpeta "troncal" del directorio de su proyecto local.
   Para mi esto es lo siguiente:
   /documents/projects/wp-plugins-public/content/scheduler/trunk/readme.txt
2. Cambie la "Etiqueta estable" a su versión de lanzamiento, "1.0"
3. Guarda el archivo
4. Haga clic con el botón derecho en el archivo "readme.txt" que acaba de actualizar y elija "SVN Commit".

¡Eso es todo! En 15 minutos más o menos:

1. El directorio de complementos de WordPress actualizará la lista de su proyecto
2. "1.0" se verá como la etiqueta estable
3. La información en "/tags/1.0/readme.txt" se utilizará para completar la página de su proyecto.

Nuevos desarrollos para su complemento

Lo más probable es que realice mejoras en su complemento y necesite publicarlas. Así es como funciona esto.

1. Realice cambios en el complemento en su directorio de trabajo.
   Estos cambios deben incluir cambios en el archivo readme.txt según sea necesario, como las entradas del registro de cambios.
2. Copie los cambios de su directorio de trabajo en su directorio de proyecto local.
3. Asegúrese de que el archivo readme.txt tenga la etiqueta "estable" correcta para la versión pública actual.
4. Haga clic con el botón derecho en el directorio del proyecto y elija "Confirmar SVN" para obtener sus nuevos cambios troncales en el directorio del servidor.
5. Haga clic con el botón derecho en el directorio "troncal" en el directorio de su proyecto y elija "Sucursal/Etiqueta" para crear una nueva etiqueta de versión para su lanzamiento. (Asegúrese de que "Crear copia dentro del repositorio desde:" esté configurado como "Copia de trabajo").
6. Haga clic con el botón derecho en el directorio del proyecto y elija "Actualización de SVN" para desplegar los cambios de etiqueta del directorio del servidor.
7. Actualice la etiqueta estable en el archivo “/trunk/readme.txt” del directorio del proyecto para que coincida con la nueva etiqueta de versión que creó.
8. Haga clic con el botón derecho en el directorio del proyecto (sí, una vez más) y elija "SVN Commit" para obtener su archivo readme.txt actualizado en el servidor.

Uf. ¡Eso es todo!

• desarrolladores
• wordpress.org