Commit 17ebadb6 authored by Steffen Börner's avatar Steffen Börner
Browse files

Add docs and maven build template

parent 1341c404
Pipeline #151405 passed with stages
in 39 seconds
stages:
- generate-docs
pages:
stage: generate-docs
image: python:3.8-buster
before_script:
- cd documentation/
- pip install -r pip-requirements.txt
script:
- mkdocs build
- mv site ../public
artifacts:
paths:
- public
\ No newline at end of file
# EXXETA Gitlab CI / CD Templates
This repository contains ready-to-use gitlab templates for building, shipping and maintaining your application with Gitlab CI.
# Documentation
The docs can be found [here]().
The docs are build using [mkdocs](https://www.mkdocs.org/). For building and serving the documentation locally, install [python](https://www.python.org/) and [pip](https://pypi.org/project/pip/) and run the following command:
pip install -r docs/pip-requirements.txt
`cd` into the `docs` directory and run:
mkdocs serve
Now you should see the documentation on [localhost:8000](http://localhost:8000).
# Template file for building container. Optional Variables:
# $OPTIONAL_MAVEN_SETTINGS_XML
.build:
script:
- |
if env | grep -q MAVEN_SETTINGS_XML; then
echo $MAVEN_SETTINGS_XML | base64 -d > .m2/settings.xml
mvn -s .m2/settings.xml clean verify
else
mvn clean verify
artifacts:
paths:
- $CI_PROJECT_DIR/target/*.jar
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment