Verwendung von Subversion mit dem WordPress-Plugin-Verzeichnis

Veröffentlicht: 2012-07-24

Befolgen Sie diese Schritt-für-Schritt-Anleitung, um Plugins im öffentlichen WordPress-Plugin-Verzeichnis hinzuzufügen und zu aktualisieren.

Diese wesentlichen Schritte aus dem Video folgen unten:

  • Erste Schritte mit Ihrem Plugin
  • Registrieren Sie sich für ein WordPress.org-Konto
  • Anfrage zum Einfügen Ihres neuen Plugins in das WordPress-Plugin-Verzeichnis
  • Installieren Sie einen SVN-Client für Ihren Computer
  • Wählen Sie ein lokales Verzeichnis für Ihre Projekte
  • Ihre Plugin-Anforderungs-Genehmigungs-E-Mail
  • Verzeichnisbegriffe für diesen Artikel
  • Pullen des neuen Serververzeichnisses auf Ihren lokalen Computer
  • Beenden Sie die Entwicklung Ihres Plugins
  • Stellen Sie Ihre erste Version der Öffentlichkeit zur Verfügung
    • Aktualisieren des Projektverzeichnisstamms
    • Markieren einer neuen Version auf dem Server
    • Aktualisieren Ihres lokalen Projektverzeichnisses mit der neuen getaggten Version
    • Aktualisieren des stabilen Tags readme.txt
  • Neue Entwicklungen für Ihr Plugin

Erste Schritte mit Ihrem Plugin

Ob Sie nur eine Idee haben oder mit Version 0.1 fast fertig sind, Sie brauchen einen Namen und eine Beschreibung für Ihr Plugin. Machen Sie den Namen kurz und aussagekräftig, um eine Vorstellung davon zu geben, was das Plugin tut. „Wax on Wax off Plugin“ ist kein guter Name. „Drop Shadow Maker“ ist viel besser. Sie müssen dem eigentlichen Titel kein „Plugin“ hinzufügen.

Passend zu deinem Titel solltest du eine kurze Beschreibung schreiben, die den Leuten erklärt, welche Vorteile dein Plugin bietet. Ich empfehle, dass diese Beschreibung weniger als 150 Zeichen lang ist.

Registrieren Sie sich für ein WordPress.org-Konto

Wenn Sie noch kein WordPress.org-Konto haben, das für die Interaktion in den Support-Foren und dergleichen verwendet wird, müssen Sie eines erstellen. Gehen Sie einfach auf: https://login.wordpress.org/register

Anfrage zum Einfügen Ihres neuen Plugins in das WordPress-Plugin-Verzeichnis

Die meisten vernünftigen Plugins, die mit einer kompatiblen Lizenz geliefert werden, können Platz im WordPress-Plugin-Verzeichnis bekommen.

  1. Gehen Sie zu: http://wordpress.org/extend/plugins/add/
  2. Geben Sie Ihren Titel und Ihre Beschreibung ein
    (Ich habe dir gesagt, dass du das brauchen würdest!)
  3. Überspringen Sie das Hochladen Ihres Plugins aus diesem Formular – selbst wenn Ihr Plugin einsatzbereit ist.

Ihre Plugin-Verzeichnisanfrage wird von echten Menschen bearbeitet, daher kann es eine Weile dauern.

Installieren Sie einen SVN-Client für Ihren Computer

Um mit dem Plugin-Verzeichnis arbeiten zu können, benötigen Sie einen Subversion-Client auf Ihrem Rechner.

  • Für Windows empfehle ich TortoiseSVN.
  • Für Mac scheint SCPlugin ein gutes Paket zu sein.

Wählen Sie einfach eine aus und lassen Sie sie installieren. Dazu gibt es nicht mehr viel zu sagen.

Wählen Sie ein lokales Verzeichnis für Ihre Projekte

Subversion wird eine lokale Kopie Ihrer Plug-in-Dateien mit dem WordPress-Plug-in-Verzeichnis auf dem neuesten Stand halten. Ich empfehle, ein Verzeichnis auf Ihrem lokalen Rechner zu erstellen, in dem Sie alle Ihre von Subversion verfolgten Projekte aufbewahren. Achtung: Wenn Sie auf Ihrem lokalen Rechner eine Webentwicklungsumgebung haben, sollten Sie nicht versucht sein, das WordPress-Plugins-Verzeichnis Ihres lokalen Webservers als Ihr Projektverzeichnis zu verwenden.

Wenn Sie beispielsweise eine lokale WordPress-Installation auf Ihrem Computer haben, wo sich der Plug-in-Ordner befindet:

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

…glauben Sie nicht, dass Sie dieses Verzeichnis verwenden können, um Ihre WordPress-Plugin-Verzeichnisprojekte zu synchronisieren. Das wird dir Schmerzen bereiten.

Erstellen Sie stattdessen ein Verzeichnis wie in diesem Beispiel:

documents/projects/wp-plugins-public/

Jeder Ihrer Plugin-Projektordner wird in „wp-plugins-public“ abgelegt. Für dieses Tutorial verwende ich einen Plugin-Ordner namens „content-scheduler“. Also werde ich ein Verzeichnis als solches erstellt haben:

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

Ihre Plugin-Anforderungs-Genehmigungs-E-Mail

Sobald Ihre Plugin-Anfrage genehmigt wurde, erhalten Sie eine E-Mail mit einem Link zu Ihrem SVN-Repository. Dies ist speziell für dieses eine Plugin und wird benötigt, um mit Ihrer Subversion-Synchronisierung fortzufahren.

Verzeichnisbegriffe für diesen Artikel

Bei so vielen verschiedenen Verzeichnissen, Projekten und Ordnern, die in diesem Artikel erwähnt werden, kann es leicht zu Verwirrung kommen. Lassen Sie uns bei der Arbeit mit diesem Subversion-Arbeitsablauf drei verschiedene Orte vereinbaren.

  1. Arbeitsverzeichnis
    Dies ist die aktuelle Kopie des Codes, den Sie ändern und testen. Es sollte sich im Ordner „/wp-content/plugins/“ auf Ihrem Entwicklungs-Webserver befinden. Auf meiner Maschine ist es zufällig:
    documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
  2. Projektverzeichnis
    Dies ist das Verzeichnis, das Ihr Subversion-Client mit dem WordPress-Plugin-Verzeichnis synchronisiert. Auf meiner Maschine ist dies:
    documents/projects/wp-plugins-public/content-scheduler/
  3. Serververzeichnis
    Dies bezieht sich auf Ihr Projekt, wie es im WordPress-Plugin-Verzeichnis gespeichert ist. Hier kann die Öffentlichkeit Ihr Plugin erhalten. Der Stammspeicherort wird Ihr „SVN-Repository“ genannt und wird Ihnen in Ihrer Genehmigungs-E-Mail für die Plugin-Anforderung zugewiesen. Für mein Beispiel ist dies:
    http://plugins.svn.wordpress.org/content-scheduler

Pullen des neuen Serververzeichnisses auf Ihren lokalen Computer

Auch wenn Sie keine Dateien an Ihrem neuen Plugin-Speicherort im Plugin-Verzeichnis abgelegt haben, müssen Sie diese Kopie des Verzeichnisses auf Ihren Computer herunterladen. Dadurch werden einige Flags hinter den Kulissen gesetzt, damit Ihr Subversion-Client weiß, was aktuell ist und was nicht.

  1. Klicken Sie mit der rechten Maustaste auf Ihren Projektverzeichnis-Plugin-Ordner.
  2. Wählen Sie „SVN Checkout“.
  3. Geben Sie Ihre WordPress-SVN-Repository-URL (aus Ihrer Genehmigungs-E-Mail) in das erste Feld ein.
  4. Ihr Projektverzeichnis-Plugin-Ordner sollte sich im zweiten Feld befinden.
    Da Sie diesen Vorgang gestartet haben, indem Sie mit der rechten Maustaste auf diesen Ordner geklickt haben, sollte dieses Feld bereits ausgefüllt sein.
  5. OK klicken"

Beenden Sie die Entwicklung Ihres Plugins

Entwickeln und testen Sie Ihr Plugin. Dazu gehört auch das Erstellen einer passenden „readme.txt“-Datei. Die Datei „readme.txt“ enthält nicht nur einige zufällige Notizen zu Ihrem Plugin. Das WordPress-Plugin-Verzeichnis verwendet den Inhalt der „readme.txt“-Datei, um zu verstehen, welche Version Ihres Plugins als aktuell gilt, und um auch den Inhalt der Seite Ihres Plugins im Verzeichnis zu erstellen.

  • Weitere Informationen zum Erstellen einer richtigen „readme.txt“-Datei finden Sie in diesem WordPress-Readme.txt-Beispiel.

Ein wesentlicher Bestandteil Ihrer „readme.txt“-Datei ist das „Stable“-Tag. Während Sie Ihr Plugin entwickeln, lassen Sie dieses Tag „trunk“ stehen. Sobald Sie eine Version für den öffentlichen Gebrauch freigeben, aktualisieren wir diese mit der richtigen Versionsnummer.

Stellen Sie Ihre erste Version der Öffentlichkeit zur Verfügung

Aktualisieren des Projektverzeichnisstamms

  1. Kopieren Sie den Inhalt Ihres Arbeitsverzeichnisses in den Ordner „trunk“ Ihres Projektverzeichnisses.
    In meinem Fall kopiere ich den gesamten Inhalt meines Plugins aus dem Arbeitsverzeichnis:
    /documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
    zu meinem Projektverzeichnis:
    /documents/projects/wp-plugins-public/content-scheduler/
  2. Klicken Sie mit der rechten Maustaste auf den Plugin-Ordner „content-scheduler“ in Ihrem Projektverzeichnis und wählen Sie „SVN Commit“.
  3. Geben Sie einen Kommentar für das Commit ein, wenn Sie möchten.
  4. Überprüfen Sie die Liste der Dateien, die als neu gelten und auf den Server kopiert werden. Wenn diese Liste korrekt aussieht, klicken Sie auf „OK“ und die Dateien werden in Ihr Serververzeichnis bei wordpress.org kopiert.

Markieren einer neuen Version auf dem Server

Sie haben die Dateien im „Trunk“ aktualisiert, aber das sollte die Öffentlichkeit nicht herunterladen. Sie müssen „Tagging“ verwenden, um eine Kopie von „trunk“ zu erstellen. Diese Kopie wird nicht weiter verändert und zur öffentlichen Nutzung angeboten. Lassen Sie uns für dieses Beispiel eine Version 1.0 erstellen.

  1. Klicken Sie mit der rechten Maustaste auf den Ordner „trunk“ des Projektverzeichnisses und wählen Sie „Branch/Tag“.
    Für mich ist das:
    /documents/projects/wp-plugins-public/content-scheduler/trunk/
  2. Das Standortfeld „To URL“ endet mit „/trunk“. Sie müssen dies in „/tags/1.0“ ändern, um Ihre Version 1.0 zu erstellen.
  3. Wenn Sie möchten, können Sie eine Notiz zu diesem Tagging-Vorgang hinzufügen.
  4. Klicken Sie auf „OK“ und ignorieren Sie alle Meldungen über „Wichtig, zu diesem Zweig zu wechseln…“.

Aktualisieren Ihres lokalen Projektverzeichnisses mit der neuen getaggten Version

Sie haben dem Server gerade gesagt, dass er eine neue Kopie Ihrer Projektdateien im Verzeichnis „/tags/1.0“ erstellen soll. Jetzt müssen wir Ihr lokales Projektverzeichnis mit diesem neuen Tag auf den neuesten Stand bringen.

Dieser Vorgang mag seltsam erscheinen. Sie fragen sich vielleicht, warum Sie nicht einfach Ihre eigene Kopie in Ihrem lokalen „/tags/1.0“-Verzeichnis erstellen können. Wenn Sie das tun, können das Serververzeichnis und das Projektverzeichnis unordentlich und verwirrt darüber werden, was aktualisiert wird und was nicht.

  • Klicken Sie erneut mit der rechten Maustaste auf das Projektverzeichnis und wählen Sie „SVN Update“.
    Dadurch werden Änderungen aus dem Serververzeichnis in Ihr lokales Projektverzeichnis gezogen. In diesem Fall ist die Änderung eine Hinzufügung der „/tags/1.0“-Kopie Ihrer Dateien.

Aktualisieren des stabilen Tags readme.txt

Alle richtigen Dateien sind vorhanden, damit die Öffentlichkeit Ihr Plugin verwenden kann. Allerdings müssen wir dem Plugin-Verzeichnis mitteilen, welche getaggte Version die Öffentlichkeit verwenden soll.

  1. Bearbeiten Sie die Datei „readme.txt“ im Ordner „trunk“ Ihres lokalen Projektverzeichnisses.
    Bei mir ist das folgendes:
    /documents/projects/wp-plugins-public/content/scheduler/trunk/readme.txt
  2. Ändern Sie das „Stable-Tag“ in Ihre Release-Version „1.0“.
  3. Speicher die Datei
  4. Klicken Sie mit der rechten Maustaste auf die gerade aktualisierte Datei „readme.txt“ und wählen Sie „SVN Commit“.

Das ist es! In 15 Minuten oder so:

  1. Das WordPress-Plugin-Verzeichnis aktualisiert Ihre Projektliste
  2. „1.0“ wird als stabiles Tag angezeigt
  3. Die Informationen in „/tags/1.0/readme.txt“ werden verwendet, um die Seite Ihres Projekts auszufüllen.

Neue Entwicklungen für Ihr Plugin

Höchstwahrscheinlich werden Sie Verbesserungen an Ihrem Plugin vornehmen und diese veröffentlichen müssen. So funktioniert das.

  1. Nehmen Sie Änderungen am Plugin in Ihrem Arbeitsverzeichnis vor.
    Diese Änderungen sollten nach Bedarf Änderungen an der readme.txt-Datei enthalten, z. B. Änderungsprotokolleinträge.
  2. Kopieren Sie Änderungen aus Ihrem Arbeitsverzeichnis in Ihr lokales Projektverzeichnis.
  3. Stellen Sie sicher, dass die readme.txt-Datei das richtige „stable“-Tag für die aktuelle öffentliche Version enthält.
  4. Klicken Sie mit der rechten Maustaste auf das Projektverzeichnis und wählen Sie „SVN Commit“, um Ihre neuen Trunk-Änderungen in das Serververzeichnis zu übertragen.
  5. Klicken Sie mit der rechten Maustaste auf das Verzeichnis „trunk“ in Ihrem Projektverzeichnis und wählen Sie „Branch/Tag“, um ein neues Versions-Tag für die Veröffentlichung zu erstellen. (Stellen Sie sicher, dass „Kopie im Repository erstellen von:“ auf „Arbeitskopie“ eingestellt ist.)
  6. Klicken Sie mit der rechten Maustaste auf das Projektverzeichnis und wählen Sie „SVN Update“, um Tag-Änderungen aus dem Serververzeichnis herunterzuladen.
  7. Aktualisieren Sie das Stable-Tag in der Datei „/trunk/readme.txt“ des Projektverzeichnisses so, dass es mit dem von Ihnen erstellten neuen Release-Tag übereinstimmt.
  8. Klicken Sie mit der rechten Maustaste auf das Projektverzeichnis (ja, noch einmal) und wählen Sie „SVN Commit“, um Ihre aktualisierte readme.txt-Datei auf den Server zu übertragen.

Puh. Das ist alles!

Haben Sie Plugins in das WordPress-Plugin-Verzeichnis hochgeladen? Teilen Sie unten Ihre Erfahrungen und Kommentare.
Stichworte:
  • Entwickler
  • wordpress.org