Come aggiungere plugin al repository di WordPress?


11

Ho appena realizzato il mio primo plug-in ed è stato approvato da WordPress. Grandi notizie per me, ma ora cosa? Le "istruzioni" sul Codice sono tutt'altro che chiare per me. Ho trovato un articolo su Dig WP e sono riuscito a raggiungere la terza riga di codice. Dopo di che nessuna gioia.

Qualcuno qui ha una serie chiara di istruzioni su come farlo senza la necessità di leggere un intero libro? Sono sicuro che ci sono persone di grande esperienza qui che fanno queste cose tutto il tempo ...

Grazie in anticipo!



@Piet: se i link menzionati da Bainternet nella sua risposta di seguito non rispondono alla tua domanda, dovremo sapere quali strumenti OS e svn stai utilizzando.
Manzabar,

scusa, avrei dovuto menzionare che sono su OSX 10.6 (Mac). Inoltre, è molto gentile da guidarmi attraverso i passaggi su come scrivere il file readme.txt, ma non è necessario in quanto il plug-in è già approvato da WordPress.org. Ora

e ho scaricato SVN dal sito ufficiale (?) ma non ho idea di come funzioni e cosa dovrei farne. Come ho già detto, ho seguito il tutorial su DIG WP e sono riuscito a completare le prime 3 righe, prima che il programma si fermasse su di me ($ mkdir my-local-dir $ svn co svn.wp-plugins.org/your-plugin- name my-local-dir $ cd my-local-dir /)

In realtà, l'applicazione non ha nulla a che fare con il file readme. Mi rivolgo spesso (e ottengo l'approvazione) prima ancora di iniziare lo sviluppo su un plugin.
EAMann,

Risposte:


12

Passaggio 1: assicurarsi che le cose siano formattate correttamente

WordPress stesso dipende dalle intestazioni nella parte superiore del file del plug-in principale. In molti casi, se il plug-in è "My Cool Plugin", questo file si trova my-cool-plugin.phpnella directory principale della cartella. Assicurarsi che la parte superiore del file segua questo 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]
*/

Il repository WordPress.org dipende dal tuo readme.txtfile per creare una descrizione e una pagina di download. Quindi assicurati che il tuo readme.txtfile si adatti al seguente 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 ==

C'è un pratico validatore del readme su WordPress.org che puoi usare per assicurarti che il tuo readme abbia tutto ciò di cui ha bisogno. Basta copiare e incollare e verificherà che tutte le sezioni siano presenti e che tu sia pronto per iniziare.

Passaggio 2: controlla il repository SVN

È una buona idea mantenere la versione di sviluppo separata dal repository dei plugin di WordPress.org. Sì, SVN viene utilizzato per il controllo della versione, ma WordPress lo utilizza maggiormente per la gestione delle versioni. Se inizi a eseguire il commit di ogni changeset nel repository, potresti incorrere in problemi. Una cosa che molti sviluppatori fanno è sviluppare localmente usando Git, quindi trasferire i tuoi file nel repository Subversion quando sei pronto per fare una versione.

Queste istruzioni presuppongono che tu stia utilizzando un computer Windows. Se sei su un Mac, puoi usare SCPlugin invece di TortoiseSVN. I passaggi che dovrai seguire saranno gli stessi, solo i menu contestuali e le schermate differiranno leggermente a causa dell'interfaccia utente. Non ho un Mac, quindi non posso creare schermate per guidarti attraverso un tutorial ... ma fidati, è lo stesso processo.

Installa TortoiseSVN se non lo hai già.

TortoiseSVN è una GUI Subversion open source per Windows. Fidati di me, usare la GUI è infinitamente più semplice che provare a fare cose dalla riga di comando. Incontrerai anche meno problemi.

Dai un'occhiata al tuo repository SVN ospitato da WordPress

Trova un luogo in cui desideri archiviare la versione del plugin ospitata su WordPress. Per impostazione predefinita, lo uso /My Documents/WordPress/per tutto il mio lavoro di sviluppo hosted. Fai clic con il pulsante destro del mouse all'interno della cartella e seleziona "Pagamento SVN" dal menu a discesa.

Menu contestuale TortoiseSVN

Nella finestra di dialogo che si apre, inserisci l'URL del repository dei plug-in di WordPress.org (ne sto usando uno dei miei a scopo dimostrativo) e scegli quale sottocartella desideri creare.

Finestra di controllo

Tortoise ci penserà un po ', poi tirerà giù il repository da WordPress.org. La cartella appena creata avrà tutte le cartelle necessarie già configurate per te. Ora devi solo copiare e incollare e eseguire il commit ... un passo alla volta.

Copia la tua ultima versione in /tags

È qui che faccio le cose all'indietro dalla maggior parte dei tutorial. Tutti gli altri ti diranno di impegnarti per /trunkprimi, ma ricorda che WordPress non usa nulla /trunktranne il file readme quando guardano i plugin. Quindi, se inserisci il tuo plugin /trunke perdi la connessione di rete (o qualcos'altro va storto) prima di commettere un tag, avrai problemi.

Nella /tagscartella, crea una cartella con lo stesso nome della versione che stai rilasciando per il tuo plugin. Quindi, se rilasci la versione 0.1, crea una /tags/0.1cartella.

Cartella Tag repository

Copia l'intero plugin in questa cartella.

Ora fai clic con il pulsante destro del mouse all'interno della cartella e seleziona "SVN Commit" dal menu a discesa.

Verrà visualizzata una finestra che mostra tutte le modifiche (dovresti vedere tutti i tuoi nuovi file contrassegnati come "senza versione").

Finestra di commit

Seleziona la casella accanto a tutti i file del tuo plug-in (o fai clic su "Seleziona tutto" per selezionarli tutti).

Nella casella in alto, inserisci un messaggio di commit. Dato che stai commettendo un tag, probabilmente dovresti usare qualcosa come:

Tagging versione 0.1 di [My Plugin].

Clicca OK.

Ancora una volta, Tortoise penserà per alcuni minuti, quindi ti chiederà il tuo nome utente e password WordPress per impegnarti nel server. Forniscili, attendi che le cose finiscano e dì "Successo", quindi passa al passaggio successivo.

Copia la tua ultima versione in /trunk

Ora vai alla /trunkcartella del repository e copia e incolla nuovamente il plug-in in quella cartella. Segui gli stessi passaggi sopra per selezionare i tuoi file e preparare il commit. Ma per un messaggio, usa qualcosa che spieghi cosa fa la nuova versione:

Versione 0.1 di [My Plugin] - aggiunge il supporto per OpenID.

Una volta che tutto è andato a buon fine, devi solo aspettare un po 'che i server di WordPress.org raggiungano. Possono essere più lenti alcuni giorni rispetto ad altri, ma entro un'ora circa dovresti vedere la tua nuova versione nel repository.

Aggiornamento di un plug-in a una nuova versione

Una volta che il tuo plugin è in libertà, preparare un aggiornamento è relativamente semplice.

Innanzitutto, utilizzare il comando SVN Update per assicurarsi di disporre dell'ultima versione del repository. Se sei l'unico sviluppatore, dovresti già, ma è buona norma aggiornarlo prima di impegnarti comunque.

Quindi seguire il processo sopra per creare una nuova sottocartella /tagsper la nuova versione. Di ', /tags/0.2. Non toccare la vecchia /0.1cartella. È lì per un motivo e non lo toccherai mai più.

Conferma il tuo nuovo tag, quindi vai alla /trunkcartella. Sostituisci tutto /trunkcon la tua nuova versione e esegui il commit come sopra. Una volta che i server si aggiornano, inizieranno a parlare della nuova versione piuttosto che di quella precedente.


1
Preferisco fare tutto dal bagagliaio, dal momento che mi permette di avere una bella storia di provenienza di ogni linea . Con il tuo approccio, non sembrerà tutto come appariva all'ultima versione?
Jan Fabry,

grazie mille per le istruzioni dettagliate @EAMann. Purtroppo sono su Mac, mi dispiace, avrei dovuto menzionarlo nella mia domanda, mio ​​cattivo ...

1
@Jan Questo è il motivo per cui ho separato il repository di sviluppo dal repository di rilascio . Ho rotto terribilmente le cose quando ho usato i repository WP.org per lo sviluppo attivo, quindi sviluppo localmente con Git o Hg per la cronologia completa delle versioni, quindi copio nel repository WP Svn quando creo una versione.
EAMann,

@Piet In tal caso, guarda SCPlugin per Mac. Le istruzioni saranno esattamente le stesse, solo le schermate differiranno. È composto da molte delle stesse persone, quindi funzionerà proprio come la tartaruga.
EAMann,

@EAMann Grazie, lo sto scaricando ora, ti farò sapere come va ...
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.