Comment ajouter un plugin au référentiel WordPress?

11

Je viens de créer mon premier plugin et il a été approuvé par WordPress. Excellente nouvelle pour moi, mais maintenant quoi? Les "instructions" sur le Codex sont tout sauf claires pour moi. J'ai trouvé un article sur Dig WP et j'ai réussi à accéder à la 3ème ligne de code. Après cela, pas de joie.

Quelqu'un ici a-t-il un ensemble clair d'instructions sur la façon de procéder sans avoir à lire un livre entier? Je suis sûr qu'il y a des gens très expérimentés ici qui font tout ça tout le temps ...

Merci d'avance!


la source
@Piet: Si les liens mentionnés par Bainternet dans sa réponse ci-dessous ne répondent pas à votre question, nous aurons besoin de savoir quels outils OS et svn vous utilisez.
Manzabar
yup désolé, j'aurais dû mentionner que je suis sur OSX 10.6 (Mac). De plus, il est très gentil de me guider à travers les étapes de la façon d'écrire le fichier readme.txt, mais pas nécessaire car le plugin est déjà approuvé par WordPress.org. Maintenant, j'étais sous l'hypothèse qu'il ne peut être approuvé que si le fichier readme.txt est validé, ce qui, soit dit en passant :)
et j'ai téléchargé SVN sur le site officiel (?) mais je n'ai aucune idée de comment cela fonctionne et de ce que je dois en faire. Comme je l'ai mentionné, j'ai suivi le tutoriel sur DIG WP et j'ai réussi à faire les 3 premières lignes, avant que le programme ne s'arrête sur moi ($ mkdir my-local-dir $ svn co svn.wp-plugins.org/your-plugin- nom my-local-dir $ cd my-local-dir /)
En fait, l'application n'a rien à voir avec le fichier Lisez-moi. J'applique souvent (et suis approuvé) avant même de commencer le développement sur un plugin.
EAMann

Réponses:

12

Étape 1 - Assurez-vous que les éléments sont correctement formatés

WordPress lui-même dépend des en-têtes en haut de votre fichier de plugin principal. Dans de nombreux cas, si votre plugin est "My Cool Plugin", ce fichier se trouve my-cool-plugin.phpdans le répertoire principal de votre dossier. Assurez-vous que la partie supérieure du fichier respecte ce format:

<?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]
*/

Le référentiel WordPress.org dépend de votre readme.txtfichier pour créer une description et une page de téléchargement. Assurez-vous donc que votre readme.txtfichier correspond au format suivant:

=== [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 ==

Il y a un validateur de readme pratique sur WordPress.org que vous pouvez utiliser pour vous assurer que votre readme a tout ce dont il a besoin. Il suffit de copier-coller et il vérifiera que toutes les sections sont là et que vous êtes prêt à partir.

Étape 2 - Découvrez le référentiel SVN

C'est une bonne idée de garder votre version de développement distincte du référentiel de plugins WordPress.org. Oui, SVN est utilisé pour le contrôle de version, mais WordPress l'utilise davantage pour la gestion des versions. Si vous commencez à valider chaque ensemble de modifications dans le référentiel, vous risquez de rencontrer des problèmes. Beaucoup de développeurs font une chose en développant localement à l'aide de Git, puis transférez vos fichiers dans le référentiel Subversion lorsque vous êtes prêt à faire une version.

Ces instructions supposent que vous utilisez un ordinateur Windows. Si vous êtes sur un Mac, vous pouvez utiliser SCPlugin au lieu de TortoiseSVN. Les étapes que vous devrez suivre seront les mêmes, seuls les menus contextuels et les captures d'écran différeront légèrement en raison de l'interface utilisateur. Je n'ai pas de Mac, donc je ne peux pas créer de captures d'écran pour vous guider dans un tutoriel ... mais croyez-moi, c'est le même processus.

Installez TortoiseSVN si vous ne l'avez pas déjà.

TortoiseSVN est une interface graphique de Subversion open source pour Windows. Croyez-moi, l'utilisation de l'interface graphique est infiniment plus facile que d'essayer de faire des choses à partir de la ligne de commande. Vous rencontrerez également moins de problèmes.

Découvrez votre référentiel SVN hébergé par WordPress

Trouvez un endroit où vous souhaitez stocker la version hébergée par WordPress de votre plugin. Par défaut, j'utilise /My Documents/WordPress/pour tout mon travail de développement hébergé. Faites un clic droit à l'intérieur du dossier et sélectionnez "SVN Checkout" dans le menu déroulant.

Menu contextuel TortoiseSVN

Dans la fenêtre de dialogue qui apparaît, entrez l'URL de votre référentiel de plugins WordPress.org (j'utilise l'un des miens à des fins de démonstration) et choisissez le sous-dossier que vous souhaitez créer.

Boîte de dialogue de paiement

La tortue réfléchira un peu, puis elle retirera le référentiel de WordPress.org. Le dossier nouvellement créé aura tous les dossiers requis déjà configurés pour vous. Maintenant, il vous suffit de copier-coller et de valider ... une étape à la fois.

Copiez votre dernière version dans /tags

C'est là que je fais les choses à l'envers à partir de la plupart des tutoriels. Tout le monde vous dira de vous engager en /trunkpremier, mais n'oubliez pas que WordPress n'utilise rien d'autre /trunkque le fichier Lisez-moi lorsque vous regardez les plugins. Donc, si vous placez votre plug-in /trunket perdez votre connexion réseau (ou quelque chose d'autre ne va pas) avant de valider une balise, vous aurez des problèmes.

Dans le /tagsdossier, créez un dossier nommé de la même manière que la version que vous publiez pour votre plugin. Donc, si vous publiez la version 0.1, créez un /tags/0.1dossier.

Dossier de balises de référentiel

Copiez l'intégralité de votre plugin dans ce dossier.

Maintenant, faites un clic droit dans le dossier et sélectionnez "SVN Commit" dans le menu déroulant.

Vous verrez une fenêtre pop-up qui montre toutes vos modifications (vous devriez voir tous vos nouveaux fichiers marqués comme "sans version").

Fenêtre de validation

Cochez la case à côté de tous les fichiers de votre plugin (ou cliquez sur "Sélectionner tout" pour les sélectionner tous).

Dans la zone en haut, entrez un message de validation. Puisque vous validez une balise, vous devriez probablement utiliser quelque chose comme:

Balisage de la version 0.1 de [My Plugin].

Cliquez sur OK.

Encore une fois, Tortoise réfléchira pendant quelques minutes, puis il vous demandera votre nom d'utilisateur et votre mot de passe WordPress afin de vous engager sur le serveur. Fournissez-les, attendez que les choses se passent et dites «Réussite», puis passez à l'étape suivante.

Copiez votre dernière version dans /trunk

Naviguez maintenant vers le /trunkdossier du référentiel et copiez-collez à nouveau votre plugin dans ce dossier. Suivez les mêmes étapes ci-dessus pour sélectionner vos fichiers et préparer la validation. Mais pour un message, utilisez quelque chose qui explique ce que fait la nouvelle version:

Version 0.1 de [My Plugin] - ajoute la prise en charge d'OpenID.

Une fois que tout est terminé, il suffit d'attendre un peu pour que les serveurs de WordPress.org se rattrapent. Ils peuvent être plus lents certains jours que d'autres, mais dans une heure environ, vous devriez voir votre nouvelle version dans le référentiel.

Mise à jour d'un plugin vers une nouvelle version

Une fois que votre plugin est dans la nature, la préparation d'une mise à jour est relativement facile.

Tout d'abord, utilisez la commande SVN Update pour vous assurer que vous disposez de la dernière version du référentiel. Si vous êtes le seul développeur, vous devriez déjà le faire, mais il est préférable de mettre à jour avant de vous engager de toute façon.

Suivez ensuite le processus ci-dessus pour créer un nouveau sous-dossier /tagspour votre nouvelle version. Dis, /tags/0.2. Ne touchez pas l'ancien /0.1dossier. Il est là pour une raison et vous ne le toucherez plus jamais.

Validez votre nouvelle balise, puis accédez au /trunkdossier. Remplacez tout /trunkpar votre nouvelle version et validez comme ci-dessus. Une fois les serveurs mis à jour, ils commenceront à parler de la nouvelle version plutôt que de l'ancienne.

EAMann
la source
1
Je préfère tout faire depuis le coffre, car cela me permet d'avoir une belle histoire d' où vient chaque ligne . Avec votre approche, tout ne ressemblera-t-il pas à la dernière version?
Jan Fabry
merci beaucoup pour les instructions détaillées @EAMann. Malheureusement, je suis sur Mac, désolé, j'aurais dû mentionner que dans ma question, ma mauvaise ...
1
@Jan C'est la raison pour laquelle je garde mon référentiel de développement séparé de mon référentiel de versions . J'ai terriblement cassé les choses lors de l'utilisation du dépôt WP.org pour le développement actif, donc je développe localement avec Git ou Hg pour l'historique complet des versions, puis je copie simplement dans le dépôt WP Svn lorsque je crée une version.
EAMann
@Piet Dans ce cas, regardez SCPlugin pour Mac. Les instructions seront exactement les mêmes, seules les captures d'écran seront différentes. Il est fabriqué par beaucoup de mêmes personnes, il fonctionnera donc comme Tortoise.
EAMann
@EAMann Merci Je le télécharge maintenant, je vais vous dire comment ça se passe ...