Utilisation de Subversion avec le répertoire de plugins WordPress
Publié: 2012-07-24Suivez ces instructions étape par étape pour ajouter et mettre à jour des plugins dans le répertoire public des plugins WordPress.
Ces étapes essentielles de la vidéo suivent ci-dessous :
- Premiers pas avec votre plugin
- Créer un compte WordPress.org
- Demande pour mettre votre nouveau plugin dans le répertoire des plugins WordPress
- Installer un client SVN pour votre machine
- Choisissez un répertoire local pour vos projets
- Votre e-mail d'approbation de demande de plugin
- Termes du répertoire pour cet article
- Extraction du nouveau répertoire du serveur sur votre machine locale
- Terminer le développement de votre plugin
- Rendez votre première version accessible au public
- Mise à jour du tronc du répertoire du projet
- Marquage d'une nouvelle version sur le serveur
- Mise à jour de votre répertoire de projet local avec la nouvelle version balisée
- Mise à jour de la balise stable readme.txt
- Nouveaux développements pour votre plugin
Premiers pas avec votre plugin
Que vous ayez juste une idée ou que vous ayez presque terminé avec la version 0.1, vous avez besoin d'un nom et d'une description pour votre plugin. Faites en sorte que le nom soit court et descriptif, donnant une idée de ce que fait le plugin. "Wax on Wax off Plugin" n'est pas un bon nom. "Drop Shadow Maker" est bien meilleur. Vous n'avez pas besoin d'ajouter "Plugin" au titre réel.
Pour accompagner votre titre, vous devez écrire une courte description indiquant aux gens les avantages de votre plugin. Je recommande que cette description soit inférieure à 150 caractères.
Créer un compte WordPress.org
Si vous n'avez pas encore de compte WordPress.org - utilisé pour interagir dans les forums d'assistance et autres - vous devez en obtenir un. Rendez-vous simplement sur : https://login.wordpress.org/register
Demande pour mettre votre nouveau plugin dans le répertoire des plugins WordPress
La plupart des plugins raisonnables livrés avec une licence compatible peuvent obtenir de l'espace dans le répertoire des plugins WordPress.
- Allez sur : http://wordpress.org/extend/plugins/add/
- Remplissez votre titre et description
(Je t'avais dit que tu en aurais besoin !) - Ignorez le téléchargement de votre plugin à partir de ce formulaire, même si votre plugin est prêt à fonctionner.
Votre demande de répertoire de plugins est traitée par de vraies personnes, cela peut donc prendre un certain temps.
Installer un client SVN pour votre machine
Pour travailler avec le répertoire des plugins, vous avez besoin d'un client Subversion sur votre machine.
- Pour Windows, je recommande TortoiseSVN.
- Pour Mac, il semble que SCPlugin soit un bon package.
Choisissez-en un et installez-le. Il n'y a pas grand-chose de plus à dire à ce sujet.
Choisissez un répertoire local pour vos projets
Subversion conservera une copie locale de vos fichiers de plugins à jour avec le répertoire de plugins WordPress. Je recommande de créer un répertoire sur votre machine locale où vous conserverez tous vos projets suivis par Subversion. Attention : si vous disposez d'un environnement de développement Web sur votre ordinateur local, ne soyez pas tenté d'utiliser le répertoire de plugins WordPress de votre serveur Web local comme répertoire de projet.
Par exemple, si vous avez une installation WordPress locale sur votre machine où se trouve le dossier plugins :
documents/public_html/devdomain.com/wp-content/plugins/
… ne pensez pas que vous pouvez utiliser ce répertoire pour synchroniser vos projets WordPress Plugin Directory. Cela vous causera de la douleur.
Au lieu de cela, créez un répertoire comme cet exemple :
documents/projects/wp-plugins-public/
Chacun de vos dossiers de projet de plugin ira dans "wp-plugins-public". Pour ce tutoriel, j'utiliserai un dossier de plug-in nommé "content-scheduler". Du coup, j'aurai fait un répertoire comme tel :
documents/projects/wp-plugins-public/content-scheduler
Votre e-mail d'approbation de demande de plugin
Une fois votre demande de plugin approuvée, vous recevrez un e-mail avec un lien vers votre référentiel SVN. Ceci est spécifiquement pour ce plugin et est nécessaire pour procéder à la synchronisation de votre Subversion.
Termes du répertoire pour cet article
Avec autant de répertoires, de projets et de dossiers différents mentionnés dans cet article, il peut être facile de se perdre. Mettons-nous d'accord sur trois emplacements différents lorsque nous travaillons avec ce workflow Subversion.
- Directeur de travail
Il s'agit de la copie actuelle du code que vous modifiez et testez. Il devrait se trouver dans le dossier « /wp-content/plugins/ » sur votre serveur Web de développement. Sur ma machine, il se trouve que :
documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/ - Répertoire du projet
C'est le répertoire que votre client Subversion gardera synchronisé avec le répertoire des plugins WordPress. Sur ma machine, c'est:
documents/projects/wp-plugins-public/content-scheduler/ - Répertoire du serveur
Cela fait référence à votre projet tel qu'il est stocké dans le répertoire des plugins WordPress. C'est là que le public pourra obtenir votre plugin. L'emplacement racine est appelé votre "référentiel SVN" et vous sera attribué dans l'e-mail d'approbation de votre demande de plugin. Pour mon exemple, c'est :
http://plugins.svn.wordpress.org/content-scheduler
Extraction du nouveau répertoire du serveur sur votre machine locale
Même si vous n'avez placé aucun fichier dans votre nouvel emplacement de plug-in dans le répertoire des plug-ins, vous devez télécharger cette copie du répertoire sur votre machine. Cela place des drapeaux dans les coulisses pour aider votre client Subversion à savoir ce qui est à jour et ce qui ne l'est pas.
- Cliquez avec le bouton droit sur le dossier du plug-in de votre répertoire de projet.
- Choisissez "Commander SVN".
- Entrez l'URL de votre référentiel WordPress SVN (à partir de votre e-mail d'approbation) dans le premier champ.
- Le dossier du plug-in de votre répertoire de projet doit se trouver dans le deuxième champ.
Puisque vous avez commencé ce processus en cliquant avec le bouton droit sur ce dossier, ce champ devrait déjà être rempli. - Cliquez sur OK"
Terminer le développement de votre plugin
Développez et testez votre plugin. Cela inclut la création d'un fichier "readme.txt" approprié pour l'accompagner. Le fichier "readme.txt" n'est pas seulement quelques notes aléatoires sur votre plugin. Le répertoire de plugins WordPress utilise le contenu du fichier "readme.txt" pour comprendre quelle version de votre plugin est considérée comme actuelle, et également pour créer le contenu de la page de votre plugin dans le répertoire.
- Pour plus d'informations sur la création d'un fichier "readme.txt" approprié, consultez cet exemple WordPress readme.txt.
Une partie essentielle de votre fichier "readme.txt" est la balise "Stable". Pendant que vous développez votre plugin, laissez cette balise lire "tronc". Une fois que vous publiez une version pour la consommation publique, nous la mettrons à jour avec le numéro de version correct.
Rendez votre première version accessible au public
Mise à jour du tronc du répertoire du projet
- Copiez le contenu de votre répertoire de travail dans le dossier "trunk" de votre répertoire de projet.
Dans mon cas, je copie tout le contenu de mon plugin depuis le répertoire de travail :
/documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
dans mon répertoire de projet :
/documents/projects/wp-plugins-public/content-scheduler/ - Cliquez avec le bouton droit sur le dossier du plug-in "content-scheduler" dans le répertoire de votre projet et choisissez "SVN Commit".
- Entrez un commentaire pour le commit si vous le souhaitez.
- Passez en revue la liste des fichiers qui sont considérés comme nouveaux et qui seront copiés sur le serveur. Si cette liste semble exacte, cliquez sur "OK" et les fichiers seront copiés dans le répertoire de votre serveur sur wordpress.org.
Marquage d'une nouvelle version sur le serveur
Vous avez mis à jour les fichiers dans le "tronc", mais ce n'est pas ce que le public devrait télécharger. Vous devez utiliser le "balisage" pour créer une copie de "tronc". Cette copie ne sera plus modifiée et sera offerte au public. Pour cet exemple, créons une version 1.0.
- Faites un clic droit sur le dossier "trunk" du répertoire du projet et choisissez "Branch/Tag".
Pour moi, c'est :
/documents/projects/wp-plugins-public/content-scheduler/trunk/ - Le champ d'emplacement "To URL" se terminera par "/trunk". Vous devez le remplacer par "/tags/1.0" pour créer votre version 1.0.
- Vous pouvez ajouter une note sur cette opération de marquage si vous le souhaitez.
- Cliquez sur "OK" et ignorez tout message "important de changer pour cette branche…"
Mise à jour de votre répertoire de projet local avec la nouvelle version balisée
Vous venez de dire au serveur de faire une nouvelle copie de vos fichiers de projet dans le répertoire « /tags/1.0 ». Maintenant, nous devons mettre à jour votre répertoire de projet local avec cette nouvelle balise.
Ce processus peut sembler étrange. Vous vous demandez peut-être pourquoi vous ne pouvez pas créer votre propre copie dans votre répertoire local « /tags/1.0 ». Si vous faites cela, le répertoire du serveur et le répertoire du projet peuvent devenir désordonnés et confus quant à ce qui est mis à jour et ce qui ne l'est pas.
- Cliquez à nouveau avec le bouton droit sur le répertoire du projet et choisissez "Mise à jour SVN".
Cela extrait les modifications du répertoire du serveur vers votre répertoire de projet local. Dans ce cas, le changement est un ajout de la copie "/tags/1.0" de vos fichiers.
Mise à jour de la balise stable readme.txt
Tous les bons fichiers sont en place pour que le public puisse utiliser votre plugin. Cependant, nous devons indiquer au répertoire des plugins quelle version taguée le public doit utiliser.
- Modifiez le fichier « readme.txt » dans le dossier « trunk » de votre répertoire de projet local.
Pour moi, c'est le suivant :
/documents/projects/wp-plugins-public/content/scheduler/trunk/readme.txt - Remplacez la "balise stable" par votre version, "1.0"
- Enregistrez le fichier
- Faites un clic droit sur le fichier "readme.txt" que vous venez de mettre à jour et choisissez "SVN Commit".
C'est ça! Dans 15 minutes environ :
- Le répertoire de plugins WordPress mettra à jour la liste de vos projets
- "1.0" sera considéré comme la balise stable
- Les informations dans "/tags/1.0/readme.txt" seront utilisées pour remplir la page de votre projet.
Nouveaux développements pour votre plugin
Très probablement, vous apporterez des améliorations à votre plugin et devrez les publier. Voici comment cela fonctionne.
- Apportez des modifications au plugin dans votre répertoire de travail.
Ces modifications doivent inclure des modifications du fichier readme.txt selon les besoins, telles que les entrées du journal des modifications. - Copiez les modifications de votre répertoire de travail dans votre répertoire de projet local.
- Assurez-vous que le fichier readme.txt a la bonne balise "stable" pour la version publique actuelle.
- Cliquez avec le bouton droit sur le répertoire du projet et choisissez "SVN Commit" pour obtenir vos nouvelles modifications de tronc dans le répertoire du serveur.
- Cliquez avec le bouton droit sur le répertoire "trunk" dans le répertoire de votre projet et choisissez "Branch/Tag" pour créer une nouvelle balise de version à publier. (Assurez-vous que "Créer une copie dans le référentiel à partir de :" est défini sur "Copie de travail".)
- Cliquez avec le bouton droit sur le répertoire du projet et choisissez "Mise à jour SVN" pour retirer les modifications de balises du répertoire du serveur.
- Mettez à jour la balise stable dans le fichier "/trunk/readme.txt" du répertoire du projet pour qu'elle corresponde à la nouvelle balise de version que vous avez créée.
- Cliquez avec le bouton droit sur le répertoire du projet (oui, une fois de plus) et choisissez "SVN Commit" pour obtenir votre fichier readme.txt mis à jour sur le serveur.
Phew. C'est tout!
Mots clés: