Utilizzo di Subversion con la directory dei plugin di WordPress

Segui queste istruzioni dettagliate per aggiungere e aggiornare i plugin nella directory pubblica dei plugin di WordPress.

Questi passaggi essenziali del video seguono di seguito:

• Iniziare con il tuo plugin
• Registrati per un account WordPress.org
• Richiedi di inserire il tuo nuovo plug-in nella directory dei plug-in di WordPress
• Installa un client SVN per la tua macchina
• Scegli una directory locale per i tuoi progetti
• La tua email di approvazione per la richiesta del plugin
• Termini di directory per questo articolo
• Estrarre la nuova directory del server sul computer locale
• Completa lo sviluppo del tuo plugin
• Rendi la tua prima versione disponibile al pubblico
  • Aggiornamento del trunk della directory del progetto
  • Tagging di una nuova versione sul server
  • Aggiornamento della directory del progetto locale con la nuova versione con tag
  • Aggiornamento del tag stabile readme.txt
• Nuovi sviluppi per il tuo plugin

Iniziare con il tuo plugin

Se hai solo un'idea o hai quasi finito con la versione 0.1, hai bisogno di un nome e di una descrizione per il tuo plugin. Rendi il nome breve e descrittivo, dando un'idea di cosa fa il plugin. "Wax on Wax off Plugin" non è un buon nome. "Drop Shadow Maker" è molto meglio. Non è necessario aggiungere "Plugin" al titolo effettivo.

Per accompagnare il tuo titolo, dovresti scrivere una breve descrizione che spieghi alle persone quali vantaggi offre il tuo plug-in. Raccomando che questa descrizione sia inferiore a 150 caratteri.

Registrati per un account WordPress.org

Se non disponi già di un account WordPress.org, utilizzato per interagire nei forum di supporto e simili, devi ottenerne uno. Basta andare su: https://login.wordpress.org/register

Richiedi di inserire il tuo nuovo plug-in nella directory dei plug-in di WordPress

I plugin più ragionevoli forniti con una licenza compatibile possono ottenere spazio nella directory dei plugin di WordPress.

1. Vai a: http://wordpress.org/extend/plugins/add/
2. Inserisci il titolo e la descrizione
   (Te l'avevo detto che ne avresti avuto bisogno!)
3. Salta il caricamento del tuo plug-in da questo modulo, anche se il tuo plug-in è pronto per l'uso.

La tua richiesta di directory del plugin viene elaborata da persone reali, quindi potrebbe volerci del tempo.

Installa un client SVN per la tua macchina

Per lavorare con la Plugin Directory, hai bisogno di un client Subversion sulla tua macchina.

• Per Windows, consiglio TortoiseSVN.
• Per Mac, sembra che SCPlugin sia un buon pacchetto.

Basta sceglierne uno e installarlo. Non c'è molto altro da dire a riguardo.

Scegli una directory locale per i tuoi progetti

Subversion manterrà una copia locale dei file dei plug-in aggiornata con la directory dei plug-in di WordPress. Ti consiglio di creare una directory sul tuo computer locale in cui manterrai tutti i tuoi progetti tracciati da Subversion. Attenzione: se disponi di un ambiente di sviluppo web sul tuo computer locale, non essere tentato di utilizzare la directory dei plugin di WordPress del tuo server web locale come directory del progetto.

Ad esempio, se hai un'installazione WordPress locale sul tuo computer in cui la cartella dei plugin è:

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

...non pensare di poter utilizzare quella directory per sincronizzare i tuoi progetti di directory di plugin di WordPress. Questo ti causerà dolore.

Invece, crea una directory come questo esempio:

documents/projects/wp-plugins-public/

Ciascuna delle cartelle del tuo progetto di plug-in andrà all'interno di "wp-plugins-public". Per questo tutorial, utilizzerò una cartella di plug-in denominata "content-scheduler". Quindi, avrò creato una directory come tale:

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

La tua email di approvazione per la richiesta del plugin

Una volta che la tua richiesta di plug-in è stata approvata, riceverai un'e-mail con un collegamento al tuo repository SVN. Questo è specifico per quel plugin ed è necessario per procedere con la sincronizzazione di Subversion.

Termini di directory per questo articolo

Con così tante directory, progetti e cartelle diverse menzionate in questo articolo, potrebbe essere facile confondersi. Siamo d'accordo su tre diverse posizioni quando si lavora con questo flusso di lavoro di Subversion.

1. Directory di lavoro
   Questa è la copia corrente del codice che stai modificando e testando. Dovrebbe essere nella cartella "/wp-content/plugins/" sul tuo server web di sviluppo. Sulla mia macchina, sembra essere:
   documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
2. Directory di progetto
   Questa è la directory che il tuo client Subversion manterrà sincronizzato con la directory dei plugin di WordPress. Sulla mia macchina, questo è:
   documents/projects/wp-plugins-public/content-scheduler/
3. Directory del server
   Questo si riferisce al tuo progetto come memorizzato nella directory dei plugin di WordPress. È qui che il pubblico potrà ottenere il tuo plug-in. La posizione principale è chiamata "repository SVN" e ti verrà assegnata nell'e-mail di approvazione della richiesta del plug-in. Per il mio esempio, questo è:
   http://plugins.svn.wordpress.org/content-scheduler

Estrarre la nuova directory del server sul computer locale

Anche se non hai inserito alcun file nella nuova posizione del plug-in nella Directory dei plug-in, devi estrarre quella copia della directory sul tuo computer. In questo modo vengono impostate alcune bandiere dietro le quinte per aiutare il tuo client Subversion a sapere cosa è aggiornato e cosa no.

1. Fare clic con il pulsante destro del mouse sulla cartella del plug-in della directory del progetto.
2. Scegli "SVN Checkout".
3. Inserisci l'URL del tuo repository SVN di WordPress (dalla tua e-mail di approvazione) nel primo campo.
4. La cartella del plug-in della directory del progetto dovrebbe trovarsi nel secondo campo.
   Poiché hai avviato questo processo facendo clic con il pulsante destro del mouse su quella cartella, questo campo dovrebbe già essere compilato.
5. Fare clic su "OK"

Completa lo sviluppo del tuo plugin

Sviluppa e testa il tuo plugin. Ciò include la creazione di un file "readme.txt" appropriato per seguirlo. Il file "readme.txt" non è solo alcune note casuali sul tuo plug-in. La directory dei plug-in di WordPress utilizza il contenuto del file "readme.txt" per capire quale versione del tuo plug-in è considerata corrente e anche per creare i contenuti della pagina del tuo plug-in nella directory.

• Per ulteriori informazioni sulla creazione di un file "readme.txt" appropriato, vedere questo esempio readme.txt di WordPress.

Una parte essenziale del tuo file "readme.txt" è il tag "Stable". Mentre stai sviluppando il tuo plug-in, lascia questo tag con la scritta "trunk". Dopo aver rilasciato una versione per il consumo pubblico, la aggiorneremo con il numero di versione corretto.

Rendi la tua prima versione disponibile al pubblico

Aggiornamento del trunk della directory del progetto

1. Copia il contenuto della tua directory di lavoro nella cartella "trunk" della directory del tuo progetto.
   Nel mio caso, sto copiando l'intero contenuto del mio plugin dalla directory di lavoro:
   /documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
   nella mia directory di progetto:
   /documents/projects/wp-plugins-public/content-scheduler/
2. Fai clic con il pulsante destro del mouse sulla cartella del plug-in "programmazione dei contenuti" nella directory del progetto e scegli "Commit SVN".
3. Inserisci un commento per il commit, se lo desideri.
4. Esaminare l'elenco dei file considerati nuovi e che verranno copiati sul server. Se questo elenco sembra accurato, fai clic su "OK" e i file verranno copiati nella directory del tuo server su wordpress.org.

Tagging di una nuova versione sul server

Hai aggiornato i file in "trunk", ma questo non è ciò che il pubblico dovrebbe scaricare. Devi usare "tagging" per creare una copia di "trunk". Questa copia non verrà ulteriormente modificata e sarà offerta per l'uso pubblico. Per questo esempio, creiamo una versione 1.0.

1. Fai clic con il pulsante destro del mouse sulla cartella "trunk" della directory del progetto e scegli "Ramo/Tag".
   Per me questo è:
   /documents/projects/wp-plugins-public/content-scheduler/trunk/
2. Il campo della posizione "All'URL" terminerà con "/trunk". Devi cambiarlo in "/tags/1.0" per creare la tua versione 1.0.
3. Se lo desideri, puoi aggiungere una nota su questa operazione di tagging.
4. Fai clic su "OK" e ignora qualsiasi messaggio su "importante passare a questo ramo..."

Aggiornamento della directory del progetto locale con la nuova versione con tag

Hai appena detto al server di creare una nuova copia dei file di progetto nella directory "/tags/1.0". Ora, dobbiamo aggiornare la directory del tuo progetto locale con quel nuovo tag.

Questo processo potrebbe sembrare strano. Potresti chiederti perché non puoi semplicemente creare la tua copia nella directory "/tags/1.0" locale. Se lo fai, la directory del server e la directory del progetto possono diventare disordinate e confuse su cosa è aggiornato e cosa no.

• Fai nuovamente clic con il pulsante destro del mouse sulla directory del progetto e scegli "Aggiorna SVN".
  Questo estrae le modifiche dalla directory del server alla directory del progetto locale. In questo caso, la modifica è un'aggiunta della copia "/tags/1.0" dei tuoi file.

Aggiornamento del tag stabile readme.txt

Tutti i file giusti sono disponibili per consentire al pubblico di utilizzare il tuo plug-in. Tuttavia, dobbiamo dire alla Plugin Directory quale versione con tag il pubblico dovrebbe usare.

1. Modifica il file "readme.txt" nella cartella "trunk" della directory del progetto locale.
   Per me, questo è il seguente:
   /documents/projects/wp-plugins-public/content/scheduler/trunk/readme.txt
2. Modifica il "tag stabile" con la tua versione di rilascio, "1.0"
3. Salva il file
4. Fai clic con il pulsante destro del mouse sul file "readme.txt" che hai appena aggiornato e scegli "SVN Commit".

Questo è tutto! In 15 minuti circa:

1. La directory dei plugin di WordPress aggiornerà l'elenco del tuo progetto
2. "1.0" sarà visto come il tag stabile
3. Le informazioni in "/tags/1.0/readme.txt" verranno utilizzate per compilare la pagina del tuo progetto.

Nuovi sviluppi per il tuo plugin

Molto probabilmente, apporterai miglioramenti al tuo plug-in e dovrai pubblicarli. Ecco come funziona.

1. Apporta modifiche al plugin nella tua directory di lavoro.
   Queste modifiche dovrebbero includere le modifiche al file readme.txt secondo necessità, come le voci del registro delle modifiche.
2. Copia le modifiche dalla tua directory di lavoro nella directory del progetto locale.
3. Assicurati che il file readme.txt abbia il tag "stable" corretto per la versione pubblica corrente.
4. Fai clic con il pulsante destro del mouse sulla directory del progetto e scegli "SVN Commit" per ottenere le modifiche al nuovo trunk nella directory del server.
5. Fai clic con il pulsante destro del mouse sulla directory "trunk" nella directory del tuo progetto e scegli "Branch/Tag" per creare un nuovo tag di versione per il rilascio. (Assicurati che "Crea copia all'interno del repository da:" sia impostato su "Copia di lavoro.")
6. Fare clic con il pulsante destro del mouse sulla directory del progetto e scegliere "SVN Update" per visualizzare le modifiche ai tag dalla directory del server.
7. Aggiorna il tag stabile nel file "/trunk/readme.txt" della directory del progetto in modo che corrisponda al nuovo tag di rilascio che hai creato.
8. Fare clic con il pulsante destro del mouse sulla directory del progetto (sì, ancora una volta) e scegliere "SVN Commit" per ottenere il file readme.txt aggiornato sul server.

Uff. È tutto!

• sviluppatori
• wordpress.org