¿Cómo agregar un complemento al repositorio de WordPress?

11

Acabo de hacer mi primer complemento y fue aprobado por WordPress. Grandes noticias para mí, pero ¿y ahora qué? Las "instrucciones" en el Codex son todo menos claras para mí. Encontré un artículo sobre Dig WP y logré llegar a la tercera línea de código. Después de eso no hay alegría.

¿Alguien aquí tiene un conjunto claro de instrucciones sobre cómo hacer esto sin la necesidad de leer un libro completo? Estoy seguro de que hay personas muy experimentadas aquí que hacen esto todo el tiempo ...

¡Gracias por adelantado!


fuente
@Piet: si los enlaces que Bainternet menciona en su respuesta a continuación no responden a su pregunta, necesitaremos saber qué herramientas de sistema operativo y svn está utilizando.
Manzabar
lo siento, debería haber mencionado que estoy en OSX 10.6 (Mac). Además, es muy amable guiarme a través de los pasos de cómo escribir el archivo readme.txt, pero no es necesario ya que el complemento ya está aprobado por WordPress.org. Ahora suponía que solo se puede aprobar si el archivo readme.txt se valida, lo que por cierto lo hace :)
y descargué SVN del sitio oficial (?) pero no tengo idea de cómo funciona y qué debo hacer con él. Como mencioné, seguí el tutorial sobre DIG WP y logré hacer las primeras 3 líneas, antes de que el programa se detuviera en mí ($ mkdir my-local-dir $ svn co svn.wp-plugins.org/your-plugin- nombre my-local-dir $ cd my-local-dir /)
En realidad, la aplicación no tiene nada que ver con el archivo Léame. A menudo aplico (y me aprueban) incluso antes de comenzar el desarrollo en un complemento.
EAMann

Respuestas:

12

Paso 1: asegúrese de que las cosas estén formateadas correctamente

WordPress en sí depende de los encabezados en la parte superior de su archivo de complemento principal. En muchos casos, si su complemento es "My Cool Plugin", este archivo se encuentra my-cool-plugin.phpen el directorio principal de su carpeta. Asegúrese de que la parte superior del archivo siga este formato:

<?php
/*
=== [Plugin Name] ===

Plugin Name: [Plugin name]
Plugin URI: [Website where plugin information can be found - your blog, maybe]
Description: [Short description of your plugin]
Author URI: [Your website]
Author: [Your name]
Version: [This version number]
*/

El repositorio de WordPress.org depende de su readme.txtarchivo para crear una descripción y una página de descarga. Así que asegúrese de que su readme.txtarchivo se ajuste al siguiente formato:

=== [Plugin Name] ===
Contributors: [Your WordPress.org username]
Donate link: [A site people can go to to give you money]
Tags: [Search terms related to your plugin]
Requires at least: [Minimum version of WordPress required]
Tested up to: [Newest version of WordPress you've tested with]
Stable tag: [This version number]

[Short, one-sentence description of your plugin]

== Description ==

[Long description of your plugin]

== Installation ==

[Steps required to install the plugin]

== Frequently Asked Questions ==

= [A question] =

[An answer]

= [Another question] =

[Another answer]

== Screenshots ==

== Changelog ==

== Upgrade Notice ==

Hay un útil validador de léame en WordPress.org que puede usar para asegurarse de que su léame tenga todo lo que necesita. Simplemente copie y pegue y comprobará que todas las secciones estén allí y que esté listo para comenzar.

Paso 2: consulta el repositorio SVN

Es una buena idea mantener su versión de desarrollo separada del repositorio de complementos de WordPress.org. Sí, SVN se usa para el control de versiones, pero WordPress lo usa más para la administración de versiones. Si comienza a confirmar cada conjunto de cambios en el repositorio, potencialmente se encontrará con problemas. Una cosa que muchos desarrolladores hacen es desarrollar localmente usando Git, luego transferir sus archivos al repositorio de Subversion cuando esté listo para hacer un lanzamiento.

Estas instrucciones asumen que estás usando una computadora con Windows. Si está en una Mac, puede usar SCPlugin en lugar de TortoiseSVN. Los pasos que deberá seguir serán los mismos, solo los menús contextuales y las capturas de pantalla diferirán ligeramente debido a la interfaz de usuario. No tengo una Mac, así que no puedo crear capturas de pantalla para guiarte a través de un tutorial ... pero créeme, es el mismo proceso.

Instale TortoiseSVN si aún no lo tiene.

TortoiseSVN es una GUI de Subversion de código abierto para Windows. Confía en mí, usar la GUI es infinitamente más fácil que intentar hacer cosas desde la línea de comandos. Te encontrarás con menos problemas también.

Consulte su repositorio SVN alojado en WordPress

Encuentre un lugar donde desee almacenar la versión alojada por WordPress de su complemento. Por defecto, lo uso /My Documents/WordPress/para todo mi trabajo de desarrollo alojado. Haga clic derecho dentro de la carpeta y seleccione "SVN Checkout" en el menú desplegable.

TortoiseSVN Menú contextual

En la ventana de diálogo que aparece, ingrese la URL del repositorio de plugins de WordPress.org (estoy usando una de las mías para fines de demostración) y elija qué subcarpeta desea crear.

Diálogo de pago

Tortoise pensará un poco, luego desplegará el repositorio de WordPress.org. La carpeta recién creada tendrá todas las carpetas necesarias ya configuradas para usted. Ahora solo copia, pega y confirma ... un paso a la vez.

Copie su última versión en /tags

Aquí es donde hago las cosas al revés de la mayoría de los tutoriales. Todos los demás le dirán que se comprometa /trunkprimero, pero recuerde que WordPress no usa nada /trunkexcepto el archivo Léame cuando mira complementos. Entonces, si coloca su complemento /trunky pierde su conexión de red (o algo más sale mal) antes de enviar una etiqueta, tendrá problemas.

En la /tagscarpeta, cree una carpeta con el mismo nombre que la versión que está lanzando para su complemento. Entonces, si está lanzando la versión 0.1, cree una /tags/0.1carpeta.

Carpeta de etiquetas de repositorio

Copie todo su complemento en esta carpeta.

Ahora haga clic derecho dentro de la carpeta y seleccione "SVN Commit" en el menú desplegable.

Verá una ventana emergente que muestra todos sus cambios (debería ver todos sus archivos nuevos marcados como "no versionados").

Ventana de confirmación

Marque la casilla junto a todos los archivos de su complemento (o haga clic en "Seleccionar todo" para seleccionarlos todos).

En el cuadro en la parte superior, ingrese un mensaje de confirmación. Como está confirmando una etiqueta, probablemente debería usar algo como:

Etiquetado de la versión 0.1 de [Mi complemento].

Haga clic en Aceptar.

Una vez más, Tortoise pensará durante unos minutos, luego le pedirá su nombre de usuario y contraseña de WordPress para comprometerse con el servidor. Bríndeles, espere a que sucedan las cosas y diga "Éxito", luego pase al siguiente paso.

Copie su última versión en /trunk

Ahora navegue a la /trunkcarpeta del repositorio y una vez más copie y pegue su complemento en esa carpeta. Siga los mismos pasos anteriores para seleccionar sus archivos y preparar la confirmación. Pero para un mensaje, use algo que explique lo que hace la nueva versión:

Versión 0.1 de [Mi complemento]: agrega soporte para OpenID.

Una vez que todo pasa, solo tienes que esperar un poco para que los servidores de WordPress.org se pongan al día. Pueden ser más lentos algunos días que otros, pero dentro de una hora más o menos debería ver su nueva versión en el repositorio.

Actualización de un complemento a una nueva versión

Una vez que su complemento está en estado salvaje, preparar una actualización es relativamente fácil.

Primero, use el comando Actualizar SVN para asegurarse de tener la última versión del repositorio. Si usted es el único desarrollador, ya debería hacerlo, pero es una buena práctica actualizar antes de comprometerse de todos modos.

Luego, realice el proceso anterior para crear una nueva subcarpeta /tagspara su nueva versión. Por ejemplo, /tags/0.2. No toques la /0.1carpeta anterior. Está ahí por una razón y nunca lo volverás a tocar.

Confirme su nueva etiqueta, luego vaya a la /trunkcarpeta. Reemplace todo /trunkcon su nueva versión y comprométase como se indicó anteriormente. Una vez que los servidores se actualicen, comenzarán a hablar sobre la nueva versión en lugar de la anterior.

EAMann
fuente
1
Prefiero hacer todo desde el baúl, ya que me permite obtener un buen historial de dónde provino cada línea . Con su enfoque, ¿no se verá todo como apareció en la última versión?
Jan Fabry
muchas gracias por las instrucciones detalladas @EAMann. Lamentablemente estoy en Mac, lo siento, debería haber mencionado que en mi pregunta, mi mal ...
1
@ Jan Esa es la razón por la que mantengo mi repositorio de desarrollo separado de mi repositorio de lanzamiento . He roto las cosas terriblemente cuando uso los repositorios de WP.org para el desarrollo activo, así que desarrollo localmente con Git o Hg para el historial completo de la versión, luego simplemente copie en el repositorio de WP Svn cuando construyo una versión.
EAMann
@Piet En ese caso, mira SCPlugin para Mac. Las instrucciones serán exactamente las mismas, solo las capturas de pantalla serán diferentes. Está hecho por muchas de las mismas personas, por lo que funcionará igual que Tortuga.
EAMann
@EAMann Gracias, lo estoy descargando ahora, te haré saber cómo va ...