Użycie TeamCity w projektach PHP cz.3 – dokumentacja projektu

Po długiej przerwie wracam do poradnika odnośnie użycia TemaCity do integracji projektów PHP.

W tej części zajmę się generowaniem dokumentacji do projektu.

Standardowo wszyscy myśląc o dokumentacji do projektów PHP chcą używać PhpDocumentatora ale projekt ten nie jest rozwijany od jakiegoś czasu i nie wspiera zmian w języku od wersji 5.3 dlatego od jakiegoś już czasu używam DocBlox. Jest to w miarę nowy system, ma małe wymagania odnośnie zasobów systemowych i generuje całkiem przyjemną dokumentację.

Instalacja

Instalacja jest prosta ale wymaga pobrania kilku dodatkowych pakietów. Najprościej zrobić to przy pomocy systemu PEAR:

pear channel-discover pear.zfcampus.org
pear channel-discover pear.michelf.com
pear install channel://pear.zfcampus.org/zf
pear install channel://pear.michelf.com/MarkdownExtra

Po spełnieniu wymagań można zainstalować pakiet przy pomocy tych poleceń:

pear channel-discover pear.docblox-project.org
pear install docblox/docblox-beta

Dodatkowo wymagany jest moduł preprocesora xslt w php oraz programu graphviz do generowania schematów klas.

Teraz wystarczy dodać nowy cel do pliku build.xml z poprzednich odcinków.

<target name="doc" depends="prepare">
    <exec executable="docblox" dir="${basedir}" failonerror="false" output="${artifactsDir}/docblox.log" >
        <arg line="run" />
	<arg line="-d ./application,./library" />
	<arg line="-t ${artifactsDir}/api" />
    </exec>
    <echo message="##teamcity[publishArtifacts '${artifactsDir}/docblox.log']" description="Import detailed log to TeamCity" />
    <zip destfile="${artifactsDir}/api.zip" whenempty="skip" basedir="${artifactsDir}/api" />
    <echo message="##teamcity[publishArtifacts '${artifactsDir}/api.zip']" description="Import documentation into TeamCity" />
</target>

Oraz dodać utworzyć katalog docelowy w akcji prepare:

<mkdir dir="${artifactsDir}/api" />

I po wszystkiem. Wystarczy dodać build step i wskazać jako cel doc oraz zaimportować dokumentację do nowej zakładki.

Dodawanie nowego kroku w ustawieniach projektu:

Ustawienia:

By dodać zakładkę trzeba wejść do ustawień serwera w panelu administracyjnym, i w zakładce „Report  Tabs” zdefiniować nowy typ raportu:

21 maja 2011 21:35 Grzegorz Drozd Brak komentarzy Komentuj Kategorie: Narz?dzia, PHP, Praca, TeamCity