Code Dokumentationen mit CI/CD generieren
Die Code Dokumentationen für JSDoc und phpDoc automatisch per CI/CD Pipeline erstellen und über Gitlab-Pages verfügbar machen.
ToDo:
-
docs
Ordner entfernen -
Pipeline Definition einbauen -
Auf Code Dokumentationen verlinken (README/Wiki)
.gitlab-ci.yml
:
Vorschlag für js_doc:
image: node:latest
stage: build
before_script:
- npm install -g jsdoc
script:
- mkdir -p docs/JSDoc
- jsdoc -c jsdoc.json
artifacts:
paths:
- docs/JSDoc
php_doc:
image: php:7.4-cli
stage: build
before_script:
- apt update && apt install wget -y
- wget https://www.phpdoc.org/phpDocumentor.phar
script:
- mkdir -p docs/phpDoc
- php phpDocumentor.phar -c phpdoc.dist.xml
after_script:
- rm phpDocumentor.phar
artifacts:
paths:
- docs/phpDoc
pages:
image: alpine:latest
stage: deploy
script:
- mkdir .public
- echo "<!DOCTYPE html><html><head><meta charset="utf-8"><meta name="generator" content="GitLab Pages"><title>SecDoc Code Dokumentation</title></head><body><p><ul><li><a href="JSDoc">Javascript Code Dokumentation</a></li><li><a href="phpDoc">PHP Code Dokumentation</a></li></ul></p></body></html>" > .public/index.html
- cp -r docs/* .public
- mv .public public
artifacts:
paths:
- public
only:
- master
Edited by Dustin Gawron