Korzystanie z Subversion z katalogiem wtyczek WordPress
Opublikowany: 2012-07-24Postępuj zgodnie z tymi instrukcjami krok po kroku, aby dodawać i aktualizować wtyczki w publicznym katalogu wtyczek WordPress.
Te podstawowe kroki z filmu znajdują się poniżej:
- Pierwsze kroki z wtyczką
- Zarejestruj konto WordPress.org
- Prośba o umieszczenie nowej wtyczki w katalogu wtyczek WordPress
- Zainstaluj klienta SVN dla swojej maszyny
- Wybierz katalog lokalny dla swoich projektów
- Twój e-mail z prośbą o zatwierdzenie wtyczki
- Warunki katalogu dla tego artykułu
- Przeciąganie nowego katalogu serwera na komputer lokalny
- Zakończ tworzenie wtyczki
- Udostępnij swoją pierwszą wersję publicznie
- Aktualizacja trunk katalogu projektu
- Oznaczanie nowej wersji na serwerze
- Aktualizowanie lokalnego katalogu projektu o nową wersję otagowaną
- Aktualizacja stabilnego tagu readme.txt
- Nowe rozwiązania dla Twojej wtyczki
Pierwsze kroki z wtyczką
Niezależnie od tego, czy dopiero masz pomysł, czy prawie skończyłeś wersję 0.1, potrzebujesz nazwy i opisu wtyczki. Nadaj nazwę krótką i opisową, dając pewne pojęcie o tym, co robi wtyczka. „Wax on Wax off Plugin” nie jest dobrą nazwą. „Drop Shadow Maker” jest znacznie lepszy. Nie musisz dodawać „Wtyczki” do rzeczywistego tytułu.
Aby dołączyć do swojego tytułu, powinieneś napisać krótki opis informujący ludzi, jakie korzyści zapewnia Twoja wtyczka. Zalecam, aby ten opis miał mniej niż 150 znaków.
Zarejestruj konto WordPress.org
Jeśli nie masz jeszcze konta WordPress.org – używanego do interakcji na forach pomocy i tym podobnych – musisz je zdobyć. Po prostu przejdź do: https://login.wordpress.org/register
Prośba o umieszczenie nowej wtyczki w katalogu wtyczek WordPress
Większość rozsądnych wtyczek dostarczanych z kompatybilną licencją może znaleźć miejsce w katalogu wtyczek WordPress.
- Przejdź do: http://wordpress.org/extend/plugins/add/
- Wpisz swój tytuł i opis
(Powiedziałem ci, że będziesz tego potrzebować!) - Pomiń przesyłanie wtyczki z tego formularza - nawet jeśli wtyczka jest gotowa do pracy.
Twoje żądanie katalogu wtyczek jest przetwarzane przez prawdziwych ludzi, więc może to trochę potrwać.
Zainstaluj klienta SVN dla swojej maszyny
Aby pracować z katalogiem wtyczek, potrzebujesz klienta Subversion na swoim komputerze.
- Dla Windows polecam TortoiseSVN.
- W przypadku komputerów Mac wydaje się, że SCPlugin jest dobrym pakietem.
Po prostu wybierz jeden i zainstaluj go. Niewiele więcej można na ten temat powiedzieć.
Wybierz katalog lokalny dla swoich projektów
Subversion będzie aktualizować lokalną kopię plików wtyczek w katalogu wtyczek WordPress. Zalecam utworzenie jednego katalogu na lokalnym komputerze, w którym będziesz przechowywać wszystkie projekty śledzone przez Subversion. Uwaga: jeśli masz środowisko programistyczne na swoim lokalnym komputerze, nie daj się skusić na używanie katalogu wtyczek WordPress na lokalnym serwerze WWW jako katalogu projektu.
Na przykład, jeśli masz lokalną instalację WordPressa na swoim komputerze, gdzie folder wtyczek to:
documents/public_html/devdomain.com/wp-content/plugins/
… nie myśl, że możesz użyć tego katalogu do synchronizacji projektów katalogu wtyczek WordPress. To sprawi ci ból.
Zamiast tego utwórz katalog taki jak w tym przykładzie:
documents/projects/wp-plugins-public/
Każdy z folderów projektów wtyczek zostanie umieszczony w „wp-plugins-public”. W tym samouczku użyję folderu wtyczek o nazwie „content-scheduler”. Tak więc zrobię katalog jako taki:
documents/projects/wp-plugins-public/content-scheduler
Twój e-mail z prośbą o zatwierdzenie wtyczki
Gdy Twoja prośba o wtyczkę zostanie zatwierdzona, otrzymasz e-mail z linkiem do Twojego repozytorium SVN. Jest to specjalnie dla tej jednej wtyczki i jest potrzebne do kontynuowania synchronizacji Subversion.
Warunki katalogu dla tego artykułu
Przy tak wielu różnych katalogach, projektach i folderach wspomnianych w tym artykule łatwo się pomylić. Ustalmy trzy różne lokalizacje podczas pracy z tym przepływem pracy Subversion.
- Katalog roboczy
To jest aktualna kopia kodu, który zmieniasz i testujesz. Powinien znajdować się w folderze „/wp-content/plugins/” na twoim deweloperskim serwerze WWW. Na moim komputerze zdarza się, że:
documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/ - Katalog projektów
Jest to katalog, który twój klient Subversion będzie synchronizował z katalogiem wtyczek WordPress. Na moim komputerze jest to:
documents/projects/wp-plugins-public/content-scheduler/ - Katalog serwera
Odnosi się to do twojego projektu zapisanego w katalogu wtyczek WordPress. To jest miejsce, w którym publiczność będzie mogła pobrać twoją wtyczkę. Lokalizacja główna nazywa się „repozytorium SVN” i zostanie przypisana do Ciebie w wiadomości e-mail z prośbą o zatwierdzenie wtyczki. Dla mojego przykładu jest to:
http://plugins.svn.wordpress.org/content-scheduler
Przeciąganie nowego katalogu serwera na komputer lokalny
Nawet jeśli nie umieściłeś żadnych plików w nowej lokalizacji wtyczki w Katalogu wtyczek, musisz ściągnąć tę kopię katalogu na swój komputer. Takie postępowanie ustawia kilka flag za kulisami, aby pomóc klientowi Subversion wiedzieć, co jest aktualne, a co nie.
- Kliknij prawym przyciskiem myszy folder wtyczki katalogu projektu.
- Wybierz „Zamówienie SVN”.
- Wpisz adres URL swojego repozytorium SVN WordPress (z e-maila z potwierdzeniem) w pierwszym polu.
- Twój folder wtyczki katalogu projektu powinien znajdować się w drugim polu.
Ponieważ rozpocząłeś ten proces, klikając prawym przyciskiem myszy ten folder, to pole powinno już być wypełnione. - Kliknij OK"
Zakończ tworzenie wtyczki
Opracuj i przetestuj swoją wtyczkę. Obejmuje to utworzenie odpowiedniego pliku „readme.txt”, który będzie z nim związany. Plik „readme.txt” to nie tylko przypadkowe notatki na temat twojej wtyczki. Katalog wtyczek WordPress wykorzystuje zawartość pliku „readme.txt”, aby zrozumieć, która wersja wtyczki jest uważana za aktualną, a także do zbudowania zawartości strony wtyczki w katalogu.
- Aby uzyskać więcej informacji na temat tworzenia prawidłowego pliku „readme.txt”, zobacz ten przykład WordPress readme.txt.
Istotną częścią pliku „readme.txt” jest znacznik „Stabilny”. Podczas tworzenia wtyczki pozostaw ten znacznik z napisem „trunk”. Po wydaniu wersji do użytku publicznego zaktualizujemy ją o prawidłowy numer wersji.
Udostępnij swoją pierwszą wersję publicznie
Aktualizacja trunk katalogu projektu
- Skopiuj zawartość katalogu roboczego do folderu „trunk” w katalogu projektu.
W moim przypadku kopiuję całą zawartość wtyczki z katalogu roboczego:
/documents/public_html/devdomain.com/wp-content/plugins/content-scheduler/
do katalogu mojego projektu:
/documents/projects/wp-plugins-public/content-scheduler/ - Kliknij prawym przyciskiem myszy folder wtyczki „content-scheduler” w katalogu projektu i wybierz „Zatwierdź SVN”.
- Wprowadź komentarz do zatwierdzenia, jeśli chcesz.
- Przejrzyj listę plików, które są uważane za nowe i zostaną skopiowane na serwer. Jeśli ta lista wygląda poprawnie, kliknij „OK”, a pliki zostaną skopiowane do katalogu serwera na wordpress.org.
Oznaczanie nowej wersji na serwerze
Zaktualizowałeś pliki w „trunk”, ale to nie jest to, co publiczność powinna pobierać. Musisz użyć „tagowania”, aby utworzyć kopię „trunk”. Ta kopia nie będzie dalej zmieniana i zostanie udostępniona do użytku publicznego. Na potrzeby tego przykładu utwórzmy wersję 1.0.
- Kliknij prawym przyciskiem myszy folder „trunk” katalogu projektu i wybierz „Branch/Tag”.
Dla mnie jest to:
/documents/projects/wp-plugins-public/content-scheduler/trunk/ - Pole lokalizacji „Do adresu URL” kończy się na „/ trunk”. Aby utworzyć wersję 1.0, musisz zmienić to na „/tags/1.0”.
- Jeśli chcesz, możesz dodać notatkę o tej operacji tagowania.
- Kliknij „OK” i zignoruj wszelkie komunikaty o „ważne, aby przejść do tej gałęzi…”
Aktualizowanie lokalnego katalogu projektu o nową wersję otagowaną
Właśnie powiedziałeś serwerowi, aby utworzył nową kopię plików projektu w katalogu „/tags/1.0”. Teraz musimy zaktualizować lokalny katalog projektu o ten nowy tag.
Ten proces może wydawać się dziwny. Możesz się zastanawiać, dlaczego nie możesz po prostu zrobić własnej kopii w lokalnym katalogu „/tags/1.0”. Jeśli to zrobisz, katalog serwera i katalog projektu mogą stać się bałaganem i pomylić z tym, co jest aktualizowane, a co nie.
- Ponownie kliknij prawym przyciskiem myszy katalog projektu i wybierz „Aktualizacja SVN”.
To ściąga zmiany z katalogu serwera do lokalnego katalogu projektu. W tym przypadku zmiana polega na dodaniu kopii „/tags/1.0” Twoich plików.
Aktualizacja stabilnego tagu readme.txt
Wszystkie odpowiednie pliki są dostępne do publicznego korzystania z Twojej wtyczki. Jednak musimy poinformować katalog wtyczek, z której otagowanej wersji ma korzystać publiczność.
- Edytuj plik „readme.txt” w folderze „trunk” lokalnego katalogu projektu.
Dla mnie jest to:
/documents/projects/wp-plugins-public/content/scheduler/trunk/readme.txt - Zmień „Tag stabilny” na swoją wersję, „1.0”
- Zapisz plik
- Kliknij prawym przyciskiem myszy plik „readme.txt”, który właśnie zaktualizowałeś i wybierz „Zatwierdź SVN”.
Otóż to! Za mniej więcej 15 minut:
- Katalog wtyczek WordPress zaktualizuje listę Twoich projektów
- „1.0” będzie postrzegany jako stabilny tag
- Informacje w „/tags/1.0/readme.txt” zostaną użyte do wypełnienia strony Twojego projektu.
Nowe rozwiązania dla Twojej wtyczki
Najprawdopodobniej ulepszysz swoją wtyczkę i będziesz musiał ją opublikować. Oto jak to działa.
- Wprowadź zmiany we wtyczce w swoim katalogu roboczym.
Zmiany te powinny obejmować zmiany w pliku readme.txt zgodnie z potrzebami, takie jak wpisy dziennika zmian. - Skopiuj zmiany z katalogu roboczego do lokalnego katalogu projektu.
- Upewnij się, że plik readme.txt zawiera poprawny znacznik „stabilny” dla bieżącej wersji publicznej.
- Kliknij prawym przyciskiem myszy katalog projektu i wybierz „SVN Commit”, aby wprowadzić zmiany w nowym trunku do katalogu serwera.
- Kliknij prawym przyciskiem myszy katalog „trunk” w katalogu projektu i wybierz „Branch/Tag”, aby utworzyć nowy tag wersji do wydania. (Upewnij się, że „Utwórz kopię w repozytorium z:” jest ustawione na „Kopię roboczą”).
- Kliknij prawym przyciskiem myszy katalog projektu i wybierz „Aktualizacja SVN”, aby pobrać zmiany tagów z katalogu serwera.
- Zaktualizuj stabilny tag w pliku „/trunk/readme.txt” katalogu projektu, aby pasował do nowego utworzonego tagu wersji.
- Kliknij prawym przyciskiem myszy katalog projektu (tak, jeszcze raz) i wybierz „Zatwierdź SVN”, aby pobrać zaktualizowany plik readme.txt na serwer.
Uff. To wszystko!
Tagi: