Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 4.06 KB

README.md

File metadata and controls

61 lines (36 loc) · 4.06 KB
Raw

TinyWeatherForecastGermany javadoc code docs

gitlab pages -> pipeline status

-> see here for the docs

-> see here for the overview page

Purpose -> Why?

Target: automatically generate code documentation for the Project Tiny Weather Forecast Germany by Pawel Dube (@Starfish).

Note: 'TWFG' is an inofficial abbreviation for Tiny Weather Forecast Germany.

Reason -> What's the added value?

  • lower the bar for contributions from the public
  • show case generation of UML diagrams for javadoc workflows

Workflow -> How does it work?

tl;dr -> it runs completely autonomously once per day at 5:20am UTC on shared runners of GitLab CI/CD

The Gitlab CI/CD pipeline defined in .gitlab-ci.yml does the following:

  1. update the shipped packages
  2. install graphviz and brotli
  3. clone the code repository from codeberg.org using git
  4. run javadoc against the code repositories java files -> the umldoclet by Talsma ICT is used instead of the default doclet to produce UML diagrams during the process.
  5. copy generated html assets to public directory

Dependencies

  • OpenJDK 11 (contained in openjdk:11-jdk docker image)
  • umldoclet -> graphviz
  • brotli and gzip -> compression of assets (js, css, images)

License/Copyright and Credits

GNU GENERAL PUBLIC LICENSE (GPLv3) please see the License file for details.

Copyright of the main project -> Tiny Weather Forecast Germany --> Pawel Dube (@Starfish)

This CI/CD script was created by Jean-Luc Tibaux (@eUgEntOptIc44).

The GZIP compression feature (high priority for SEO) was integrated using intel shared by Christian Danscheid.

The umldoclet by Talsma ICT uses graphviz via PlantUML.

javadoc bugfixes

Bugfix to use javadoc with openjdk versions newer then 8 -> https://stackoverflow.com/questions/38621202/ignore-minor-errors-using-javadoc/63683772#63683772 -> --ignore-source-errors -> provided by user Marteng -> License: CC BY-SA 4.0

Bugfix to resolve javadoc search 'undefined' error -> https://stackoverflow.com/questions/52326318/maven-javadoc-search-redirects-to-undefined-url#52603413 -> --no-module-directories -> provided by user Radoslav Ivanov -> License: CC BY-SA 4.0

Contributing

  • As noted above contributions to Tiny Weather Forecast Germany are managed at the 'main' code repository
  • Please feel free to contribute to this script by opening issues and/or merge requests.
  • Translations of Tiny Weather Forecast Germany are managed at the weblate instance provided by Marcus Hoffmann (@Bubu).
  • For cybersec, privacy and/or copyright related issues regarding this repository please directly contact the maintainer Jean-Luc Tibaux (@eUgEntOptIc44)