Changes

Page history
Update Continuous Integration and Delivery authored by Jens Henrik Goebbert's avatar Jens Henrik Goebbert
Show whitespace changes
Inline Side-by-side
Continuous-Integration-and-Delivery.md
View page @ 86c0111e
......@@ -245,15 +245,23 @@ It is generated beside other badges in [ci/badge-static.sh](https://gitlab.versi
To include the badges to your project front-page, they can be set in Project->Settings->Badges like this:
![GitLab-Pipeline__SetBadges](/uploads/630320add68c17e5c1c3a2335af1e8af/GitLab-Pipeline__SetBadges.png)
#### Dokumentation
The [CI Job "deploy-doc"](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/.gitlab-ci.yml#L269) generates automatically a documentation using [Doxygen](http://www.doxygen.nl/) using [THIS configurations](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/doc/doxyfile.in) and [THIS project CI Script](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/ci/deploy-doxygenhtml.sh). The generated HTML files are made available online with [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/) under http://vis.pages.jsc.fz-juelich.de/jusense-cicd/
#### GitLab Pages
To publish static webpages with GitLab Pages one needs to create a CI Jobs called "pages" in the .gitlab-ci.yml file like it is done for this project [HERE](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/.gitlab-ci.yml#L300). This CI Job needs to have an artifact with the name "pages" with the path "public/" like it is done for this project [HERE](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/.gitlab-ci.yml#L319).
In this project the [CI Job "deploy-doc"](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/.gitlab-ci.yml#L269) shares a cache with the [CI Job "pages"](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/.gitlab-ci.yml#L300) and the static webpages are just copied from the cache to the public folder [HERE](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/.gitlab-ci.yml#L318).
In this project the [CI Job "deploy-webpage"](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/ci/deploy-webpage.sh) and the [CI Job "deploy-doc"](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/.gitlab-ci.yml#L269) copys their results directly into the artifacts "pages" and the [CI Job "pages"](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/.gitlab-ci.yml#L300) pushes the public folder [HERE](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/.gitlab-ci.yml#L318) on GitLab's webserver, which is realized with [NGINX](https://www.nginx.com).
![GitLab_PagesDoxygen](/uploads/822eb75094d06d7fbb5797b1e53352d9/GitLab_PagesDoxygen.png)
##### Webpage
The [CI Job "deploy-webpage"](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/.gitlab-ci.yml#L269) generates automatically a static webpage using [Jekyll](https://jekyllrb.com/), [THIS project CI Script](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/ci/deploy-webpage.sh) and [THIS webpage folder](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/tree/master/doc/webpage), which is base on [THIS SinglePage template](https://github.com/t413/SinglePaged) and [THIS implementation](https://site.mockito.org).
The content is written in Markdown language [HERE](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/tree/master/doc/webpage/_posts). [THIS script]() generates parts of the content (eg. Download section) based on information it gathers through the GitLab Rest API. The generated HTML files are made available online under http://vis.pages.jsc.fz-juelich.de/jusense-cicd/
![JuSense_Webpage](/uploads/c396d3f031cefe01466823144e27af86/JuSense_Webpage.png)
##### Dokumentation
The [CI Job "deploy-doc"](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/.gitlab-ci.yml#L269) generates automatically a documentation using [Doxygen](http://www.doxygen.nl/), [THIS configurations](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/doc/doxyfile.in) and [THIS project CI Script](https://gitlab.version.fz-juelich.de/vis/jusense-cicd/blob/master/ci/deploy-doxygenhtml.sh). The generated HTML files are made available online under http://vis.pages.jsc.fz-juelich.de/jusense-cicd/doc
![GitLab_PagesDoxygen](/uploads/822eb75094d06d7fbb5797b1e53352d9/GitLab_PagesDoxygen.png)
# Continuous Delivery/Deployment (CD) Pipeline
......
......