Was Stable Tag bewirkt und warum der Falsche nichts versendet

Das erste Plugin, das ich auf WordPress.org gesetzt habe, hat neun Tage lang nichts verschickt, ich hatte den Code festgelegt, die Veröffentlichung markiert, mir das Listing-Update mit meiner neuen Beschreibung angesehen und den Leuten gesagt, dass es draußen ist Downloads blieben flach, weil der Download-Button einen leeren Tag-Ordner bediente: mein readme.txt Sagte Stable tag: 1.0.1 Und das Tag, das ich tatsächlich erstellt hatte, war 1.0Nichts hat mich gewarnt Das Verzeichnis hat genau das gemacht, was ich ihm gesagt habe.

Diese Zeile ist das Feld mit den höchsten Einsätzen in einem WordPress-Plugin's readme.txt‘und es ist eines von mehreren, die eher leise als laut scheitern Diese Anleitung behandelt, was das Verzeichnis mit jedem Teil dieser Datei macht, in der Reihenfolge, in der der Schaden tendenziell passiert Die WordPress Readme Generator Erstellen Sie die Datei mit diesen Regeln, die den Feldern beigefügt sind, auf die sie anwendbar sind.

tl; dr: Stable tag Benennt die Version, der das Verzeichnis tatsächlich dient Es wird ausgelesen trunk/readme.txtund es zeigt auf einen Ordner darunter /tags/ Das muss es geben und muss die Freigabe enthalten, nennt sie eine Version, die nicht da ist, bekommen die User nichts; benennt sie noch eine alte, bekommen sie alten Code, egal was man sich vorgenommen hat. Tested up to Steuert die Kompatibilitätswarnung auf Ihrem Eintrag Tags Indiziert nur die ersten fünf und die Kurzbeschreibung ist auf 150 Zeichen gekürzt.

Was steuert Stable Tag eigentlich?

Ein Plugin im Verzeichnis lebt in Subversion, mit trunk/ für die aktuelle Entwicklung und tags/<version>/ Für Releases Wenn jemand auf Download klickt, sendet das Verzeichnis ihn nicht trunk. Es lautet trunk/readme.txt(fundet Stable tagund dient tags/<that value>/drohen

Es folgen drei Konsequenzen, und alle drei beißen echte Freisetzungen:

• Die Lesekomponente, die darüber entscheidet, ist die im Kofferraum. Das Bearbeiten des Readme in einem Tag-Ordner ändert nichts daran, was versendet wird.
• Das Tag muss es geben. ein Stable tag Einen Ordner zu benennen, der nie erstellt wurde, bedeutet, dass der Download leer ist oder fehlschlägt.
• Trunk ist nicht das, was Benutzer erhalten. Sie können sich die ganze Woche auf Trunk festlegen; Bis sich das stabile Tag bewegt, ist der veröffentlichte Code das, was das alte Tag enthält.

der Plugin-handbuch Stellt die Regel klar dar, und es lohnt sich, einmal richtig zu lesen, anstatt ein Readme von einem anderen Plugin zu kopieren und die Felder zu bearbeiten Die eine Ausnahme, die es zu wissen gilt: Stable tag: trunk Bedeutet " trunk & quot; bedienen, was legal ist und so eine Handvoll Plugins freigeben Es bedeutet auch, dass jeder Commit to trunk für jeden Benutzer sofort live ist, weshalb es fast niemand tun sollte.

Es gibt eine zweite Hälfte zum Release, die das Readme gar nicht kontrolliert Die Version in Stable tag Passen muss die Version: Header in Ihrer Haupt-Plugin-PHP-Datei, denn das ist es, was eine installierte Seite vergleicht, um zu entscheiden, ob ein Update existiert Versenden Sie ein Tag, dessen Plugin-Header noch die vorherige Nummer angibt und das Verzeichnis bietet ein Update, das etwas installiert, das behauptet, die Version bereits vorhanden zu sein.

Was jede Header-Zeile mit Ihrem Eintrag macht

Der Header-Block besteht aus neun Zeilen Klartext Key: value Und jeder von ihnen verändert etwas Sichtbares.

Linie	Was es tut	Was schief geht
Stable tag	Pickt die servierte Version	Falscher Wert versendet nichts oder versendet alten Code
Requires at least	Mindestversion WordPress	Zu hohe Blöcke installieren, die funktionieren würden
Tested up to	Kompatibilitätserklärung	Ein Zurückfallen zeigt eine & quot; ungetestete" Warnung
Requires PHP	Mindest-PHP-Version	Zu niedrig lässt inkompatible Websites installieren und fehlschlagen
Tags	Verzeichnisschlüsselwörter	Nur die ersten fünf sind indiziert
Contributors	Links WordPress.org Profile	Ein Tippfehler schreibt stillschweigend niemandem zu
Donate link	Seitenleiste Spendenknopf	Abwesenheit ist in Ordnung, gebrochen ist nicht
License / License URI	Die Lizenz	Muss GPL-kompatibel sein, um aufgeführt zu werden

Tested up to Ist die, die Downloads lautlos kostet Wenn es mehr als ein paar Kern-Releases zurückfällt, zeigt die Auflistung einen Hinweis, der Besuchern mitteilt, dass das Plugin mit ihrer WordPress-Version ungetestet ist, und ein Plugin, das verlassen aussieht, wird weniger installiert, unabhängig davon, ob es funktioniert Das Aktualisieren dieser Zeile ist ein Readme-Commit für Trunk und dauert eine Minute, was die günstigste Wartung im Ökosystem ist.

Tags Indiziert fünf Ein sechstes Tag ist kein Fehler und erzeugt keine Warnung; es ist einfach toter Text in Ihrer Datei Wählen Sie die fünf Personen, die tatsächlich tippen.

Wie ist die Beschreibung aufgeteilt und warum spielt sie eine Rolle?

Es gibt zwei Beschreibungen in einer Lektüre und sie erledigen unterschiedliche Aufgaben.

der Kurzbeschreibung Ist der einzelne Textblock zwischen den Kopfzeilen und der ersten == Section ==. Es ist auf 150 Zeichen begrenzt, und vorbei, dass das Verzeichnis es in den Suchergebnissen und auf der Plugin-Karte, normalerweise Mitte des Satzes, kürzt Dies ist die Zeile, die die meisten Leute lesen, bevor sie entscheiden, ob sie klicken, was 150 Zeichen zur wertvollsten Immobilie in der Datei macht.

der Langbeschreibung ist das == Description == Abschnitt und es wird zum Hauptteil Ihrer Listing-Seite Es nimmt eine Teilmenge von Markdown: Überschriften, fett, kursiv, Listen, Links Rohes HTML wird entfernt Tabellen, eingezäunte Codeblöcke mit Syntaxhervorhebung, und der exotischere Markdown rendern nicht, so dass ein Readme, der in einem Markdown-Vorschaugerät richtig aussieht, auf WordPress.org immer noch falsch aussehen kann.

Die anderen Abschnitte werden jeweils einer Registerkarte der Auflistung zugeordnet:

== Description ==            the main body
== Installation ==           the Installation tab
== Frequently Asked Questions ==   the FAQ tab, one "= question =" per entry
== Screenshots ==            numbered captions, matched to files in /assets/
== Changelog ==              one "= version =" block per release, newest first
== Upgrade Notice ==         the short line shown inside wp-admin on update

Upgrade Notice Verdient mehr Aufmerksamkeit, als es normalerweise bekommt Es ist der einzige Text, den die meisten Benutzer sehen, bevor sie auf Update klicken: ein oder zwei Zeilen, in der Update-Eingabeaufforderung, um zu erklären, warum diese Version wichtig ist Ein Sicherheitsfix, eine brechende Änderung, eine neue PHP-Anforderung Leer gelassen, ist das Update nur eine Zahl.

Wo wohnen Banner und Icon?

Nicht in readme.txt. Das stolpert fast bei jedem beim ersten Mal nach oben, denn die Readme ist dort, wo jeder zweite Inhalt der Auflistung herkommt.

Bilder leben in einem /assets/ Verzeichnis in SVN, daneben trunk und tagsund sie werden durch den Dateinamen abgeglichen:

Datei	Zweck	Größe
banner-772x250.png	Listenkopf	772 x 250
banner-1544x500.png	Netzhautkopf	1544 x 500
icon-128x128.png	Suchergebnissymbol	128 x 128
icon-256x256.png	Netzhautsymbol	256 x 256
screenshot-1.png	Erster Screenshot	irgendein

Die Screenshots verbinden sich wieder mit dem Readme nach Nummer. screenshot-1.png Wird durch die erste Zeile unter beschrieben == Screenshots ==, screenshot-2.png Durch die zweite, und so weiter Eine Bildunterschrift ohne passende Datei zeigt nichts; eine Datei ohne Bildunterschrift zeigt ein unbeschriftetes Bild.

Wie sieht ein guter Changelog aus?

Ein Block pro Version, der neueste oben, in jeder Zeile steht, was sich vom Benutzer geändert hat's-Sicht:

= 3.2.5 =
* Fixed: admin menu order lost after a role change
* Improved: login customizer previews without saving

= 3.2.4 =
* Added: per-role dashboard widget visibility

" Bugfixes und Verbesserungen" sagt einem Benutzer nichts und sagt einem Rezensenten weniger, Im Changelog schaut auch jeder, der entscheidet, ob er seinem Plugin vertrauen möchte, zuerst: Eine stetige Liste spezifischer Einträge liest sich als Wartung, und eine Lücke von zwei Jahren liest sich als Aufgabe, ob der Code noch funktioniert oder nicht.

Lange Changelogs sind in Ordnung zu trimmen Halten Sie die letzten Veröffentlichungen in readme.txt und den Rest zu einem verschieben changelog.txt; Das Verzeichnis liest das beschnittene Verzeichnis und der Verlauf bleibt im Repository.

Überprüfen Sie die Datei, bevor Sie sie versenden

Die mechanischen Kontrollen sind schnell: tut Stable tag Übereinstimmung mit einem existierenden Tag-Ordner, stimmt dieser mit dem überein Version: In Ihrem Plugin-Header ist Tested up to Aktuell, ist die Kurzbeschreibung unter 150 Zeichen, gibt es fünf Tags oder weniger.

WordPress.org hat eine Offizieller Readme-Validator Das eine Datei analysiert und meldet, was sie nicht lesen konnte, was es wert ist, einmal pro Release ausgeführt zu werden Die Readme-generator Geht in die andere Richtung: Es erstellt die Datei aus Feldern, gibt jede dieser Grenzen neben dem Feld an, auf das sie zutrifft, gibt eine Vorschau auf die Liste, die die Datei erstellen wird, und liest eine vorhandene readme.txt Zurück in das Formular, sodass eine alte Plugin's-Datei auf den neuesten Stand gebracht werden kann, ohne sie erneut einzugeben.

Wenn Sie sich andere Leute ansehen und #39;s-Plugins verwenden, anstatt Ihre eigenen zu veröffentlichen, ist die WordPress-Plugin-Detektor Listet auf, was eine Seite lädt und was Themendetektor Liest das Thema dahinter.