PHPPamokos.lt


14. Publikavimas - įkėlimas į WordPress.org katalogą

Namų darbai

Kadangi prie kodo daugiau beveik nesiliesime, šis namų darbas buvo jau paskutinis, o tinyRelated v0.11.1 - paskutinė versija prieš siuntimą į wordpress.org peržiūrai ir patvirtinimui. Pakeitimai šį kartą - tik widget.php ir options.php failuose. Buvo atrastos ir pažymėtos 7 papildomos verstino teksto eilutės - skydelio pavadinimas ir pan.

Siuntimas patvirtinimui

Galutinę, suarchyvuotą tinyRelated v0.12.0 versiją, kuri buvo nusiųsta į WordPress.org galite oparsisiųsti iš čia. Prieš siunčiant įskiepį pradinei peržiūrai ir patvirtinimi, reikėjo atlikti dar porą pakeitimų.

Pirmiausiai, naudojantis poEdit programa buvo parengtas ir į languages pakatalogį išsaugotas lietuviškas įskiepio vertimas, t.y. failai tinyrelated-lt_LT.po bei tinyrelated-lt_LT.mo. Kadangi įskiepis nedidelis, tai ir vertimo nebuvo daug - iš viso tik 19 teksto eilučių. Ši dalis neprivaloma, bet aš stengiuosi visiems savo įskiepiams pateikti lietuvišką vertimą.

Antras, privalomas darbas - readme.txt failo paruošimas. Nors šiaip įskiepio veikimui jis nėra būtinas, tačiau jei norėsite publikuoti įskiepį WordPress.org kataloge - be jo neišsiversite. Šiame faile pateikiama pagrindinė informaciją apie įskiepį - versija, aprašymas, diegimo instrukcija, dažnai užduodami klausimai, ir pan. - kurią WordPress.org įskiepių katalogas naudoja jūsų įskiepio pristatomajam puslapiui sugeneruoti.

Kadangi šis puslapis - http://wordpress.org/plugins/jusuiskiepis - bus jūsų įskiepio veidas, patariu tam skirti tikrai daug dėmesio ir padaryti tvarkingai. Tiesa, pradiniam patvirtinimui siunčiamo įskiepio readme.txt failas dar neturi būti galutinai užbaigtas (tą galima padaryti vėliau, prieš publikuojant), tačiau jau turi būti tvarkingas ir atitikti bent minimalius reikalavimus.

Readme.txt failas turi būti renkiamas pagal specialų šabloną - čia galite rasti jo pavyzdį, kuris kartu yra ir gan neblogas šio failo reikalavimų ir galimybių aprašymas. Naudojama speciali sintaksė, šiek tiek panaši (bet ne identiška) į Markdown. Faile turi būti numatyti skyreliai, vėliau paverčiami į tab'us įskiepio puslapyje, be to, galima pridėti savų skyrelių.

Pabaigus rašyti savo readme.txt, labai rekomenduoju pasinaudoti WordPress pateikiamu validatoriumi, kuris parodys žioplas klaidas ir leis įvertinti, kaip atrodys galutinis rezultatas.

Atlikus šiuos darbus, jau galima įskiepį siųsti peržiūrai. Tai daroma per specialią formą (reikia būti prisiregistravus ir prisijungus prie wordpress.org - jeigu dar neturite ten sąskaitos, pats laikas tai padaryti). Forma prašo trijų dalykų - įskiepio pavadinimo (pagal jį bus generuojamas jūsų įskiepio vardas), trumpas veikimo aprašymas ir nuoroda į suarchyvuotą įskiepį, padėtą kažkur internete.

Įskiepio siuntimo peržiūrai forma

Kaip matote, šiuo metu yra peržiūros laukiančių įskiepių eilutė. Ji visuomet yra daugmaž panašaus ilgio (apie 50 įskiepių), todėl patvirtinimo tenka šiek tiek palaukti. Patvirtinimo laikas šiek tiek varijuoja - greičiausiai atsakymą esu gavęs per kelias valandas, ilgiausiai teko laukti apie porą dienų. Paprasti įskiepiai peržiūrimi greičiau, sudėtingesni, stambesni paprastai užtrunka ilgiau. Todėl rekomenduoju pradiniam vertinimui siūsti MVP - minimalų veikiantį produktą. Taip greičiau gausite patvirtinimą, ir užimsite norimą įskiepio vardą, o patvirtinimas neįpareigoja jūsų tučtuojau išleisti įskiepį viešai arba išleisti būtent tokią versiją, kokią siuntėte patvirtinimui. Žinoma, jei išleisite visiškai kitokį įskiepį, nei siuntėte, bus problemų, bet jei tiesiog atsiras šiek tiek patobulinimų - niekas nesipiktins.

Pirmą atsakymą iš plugins@wordpress.org būtinai gausite per 7 dienas arba anksčiau. Jeigu įskiepis atitiko reikalavimus, gausite priėjimą prie jam skirtos Subversion repozitorijos ir jums palinkės sėkmės. Kadangi tinyRelated buvo labai paprastas, patvirtinimas neužruko ir jau kitą rytą į pašto dėžutę atėjo štai toks pranešimas:

Įskiepio patvirtinimo laiškas

Atmetimas

Jeigu nutiktų taip, kad siųstas įskiepis turi trūkumų, jums bus duotos 7 dienos jiems ištaisyti. Jeigu nespėsite, įskiepis bus atmestas ir teks jį siųsti iš naujo. Kodėl įskiepis gali būti atmestas? Daug priežasčių, dažniausias iš jų WordPress pateikia savo įskiepių kūrėjų DUK:

  • nėra readme.txt;
  • klaidos kode, pasimatančios įjungus WP_DEBUG konstantą wp-config.php faile;
  • naudojamos atskiros JavaScript bibliotekų, įtrauktų į WordPress šerdį versijos;
  • naudojami išoriniai failai (su tam tikromis išimtimis, kai kalba eina apie išorinius servisus) - jokių CDN JavaScript ar CSS failams;
  • "Powered-By" nuorodos įterpimas į viešą svetainės dalį be žmogaus atskiro leidimo (opt-in);
  • Užklausos į išorinius serverius - bet koks duomenų rinkimas apie įskiepio vartotojus į išorinį serverį. Vėlgi, tam tikros išimtys su vartotojo leidimu ir išoriniais servisais;
  • ir t.t.

Dar pridėsiu - nepalikti jokių nereikalingų failų įskiepio kataloge. Mano praktikoj vienintelis kartas, kai negavau patvirtinimo iš karto, nutiko tuomet, kai nusiųstame .zip faile buvau palikes readme.md failą, skirtą GitHub. Teko ištrinti ir siųsti pataisytą.

O šiaip bendras patarimas - nesielkite kaip spameris, laikykitės rekomendacijų įskiepių kūrėjams ir viskas bus tvarkoje. WordPress įskiepių kokybės kontrolė tikrai nepasižymi perdėtu griežtumu ar reiklumu.

Parengimas publikavimui

Gavus patvirtinima nėra privaloma iš karto publikuoti įskiepį - galite ramiai pasiruošti, iki galo susitvarkyti viską ir tada spausti junginklį. tinyRelated atveju aš dar padariau kelis smulkius pakeitimus - sukėliau options.php ir widget.php į includes kategoriją, praplėčiau ir patobulinau readme.txt, bei pakėliau versijos numerį iki 1.0.0 (pirmas tikras leidimas!). Galutinę įskiepio versiją galite rasti GitHub repozitorijoje.

Tuomet teliko paruošti asset'us. WordPress įskiepių direktorija greta teksto leidžia šiek tiek koreguoti ir grafinius įskiepio puslapio dalykus:

  • Ekrano vaizdų skiltį;
  • Įskiepio antraštinį paveikslėlį;
  • Įskiepio piktogramą;

Ekrano vaizdai. Galite pridėti savo įskiepio ekrano vaizdų. Jie būtinai turi būti išsaugoti pagal pavadinimo formatą screenshot-{nr}.(jpg|jpeg|png|gif) (screenshot-1.png, screenshot-2.jpg, screenshot-3.gif ir t.t.), o readme.txt failo Screenshots skiltyje - pateikti aprašymai ta pačia eilės tvarka.

Antraštinis paveikslėlis. 772x250 pikselių dydžio paveikslėlis, rodomas įskiepio pavadinimo srityje. tinyRelated ten rodoma abstrakti bibliotekos/knygyno nuotrauka. Ji turi būti išsaugoma pavadinimu banner-772x250.(jpg|png). Jei norite pasitikrinti, kaip jūsų parinkta nuotrauka atrodys įskiepio puslapyje, tai galima padaryti naršyklę nukreipus adresu http://wordpress.org/plugins/jusuiskiepis?banner_url=URL_IKI_JUSU_PPAVEIKSLELIO (veikia tik prisijungus ir tik su jūsų įskiepiais).

tinyRelated įskiepio antraštė

Piktograma. Nuo 4.0 versijos WordPress atnaujino įskiepių diegimo vedlį WP Admin sąsajoje. Dabar šalia įskiepio pavadinimo vaizduojama jo piktograma, taip pagyvinant vaizdą ir palengvinant įskiepių atpažinimą. Piktograma pateikiama tokiais failais: icon-128x128.(png|jpg), icon-256x256.(png|jpg) ir icon.svg

tinyRelated įskiepio piktograma įskiepių paieškos lange

Visi šie failai „gyvena“ įskiepio Subversion repozitorijos assets kataloge. Jie nėra būtini, tačiau tikrai pagyvina įskiepio vaizdą, padeda išsiskirti ir būti pastebėtam, todėl dauguma modernių, aktyviai vystomų įskiepių juos naudoja. tinyRelated įskiepio assets turinį galite pamatyti GitHub repozitorijos assets šakoje.

Publikavimas su Subversion

Norint savo įskiepį publikuoti WordPress.org kataloge, reikia naudotis jų suteikiama Subversion repozitorija. Aš pats kodo versijų kontrolei paprastai naudoju git ir GitHub, ir tik naujas versijas eksportuoju ir publikuoju Subversion pagalba. Deja, mano procesas remiasi Bash skriptais, komandine eilute ir Linux operacine sistema, tad šio kurso apimčiai yra šiek tiek per daug komplikuotas, todėl čia aptarsime paprastesnį atvejį kai yra naudojama tik Subversion sistema ir į ją siunčiami tik versijų atnaujinimai.

Taigi, jums pateikta Subversion repozitorija jau turi tokią struktūrą (4 tuščius katalogus):

  • assets
  • branches
  • tags
  • trunk

Norėdami naudtis šia repozitorija pirmiausiai turėsite ją parsisiųsti į savo komputerį naudojant „Checkout“ komandą. Komandinėje eilutėje tai atrodytų taip:

svn co http://plugins.svn.wordpress.org/manoiskiepis manokatalogas

(manokatalogas turėtų jau egzistuoti ir būti tuščias). Jei naudojate grafinę sąsają, tokią kaip TortoiseSVN Windows platformoje, joje bus atitinkama komanda pagrindiniame arba kontekstiniame meniu.

Tuomet į tinkamas vietas reikėtų sukelti jūsų įskiepio failus. Asset'ai turėtų patekti į assets katalogą, pagrindiniai įskiepio failai - į tags/VERSIJA/ katalogą (pvz. tags/1.0.0, jei tai - 1.0.0 versija), o readme.txt kopija - į trunk katalogą. Readme.txt failas taip pat turi būti ir kartu su pagrindiniais įskiepio failais, jo trunk kopija naudojama tik tam, kad būtų atrinta, kuri versija iš tags šiuo metu yra naujausia (Stable Tag lauko reikšmė).

Įkėlus failus, reikėtų Subversion pranešti apie pakeitimus. Tai galima padaryti "Add" komandos pagalba grafinėje sąsajoje arba komandinėje eilutėje:

svn add *

Ir paskutinis žingsnis - šiuos pakeitimus išsiųsti į WordPress.org serverį, atliekamas "Commit" komanda.

svn ci -m "Trumpa žinutė"

Žinutėje aš paprastai nurodau, kuri versija yra siunčiama.

Viskas. Telieka palaukti kelias minutes, kol WordPress.org įskiepių katalogas atnaujins informaciją. Tai vyksta automatiškai, kas keletą minučių, taigi nueikite pasidaryti kavos, o kai grįšite, įskiepis jau bus paskelbtas.



(c) 2015-2018. Visais klausimais kreipkitės povilas@laraveldaily.com