Skip to content

Commit

Permalink
update contents
Browse files Browse the repository at this point in the history
  • Loading branch information
@twfgcicdbot
twfgcicdbot committed Nov 18, 2024
0 parents commit 017c3fe
Show file tree
Hide file tree
Showing 390 changed files with 30,523 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .github/workflows/gh_deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Deploy static content to GitHub Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["gh-pages"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: '.'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
Empty file added .gitkeep
Empty file.
1 change: 1 addition & 0 deletions 403.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<html lang=en><head><title>Error 403</title><link rel=stylesheet type=text/css href=javadoc-styles.min.css></head><body><div>Access <strong>denied</strong>!</div></body></html>
1 change: 1 addition & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<html lang=en><head><title>Error 404</title><link rel=stylesheet type=text/css href=javadoc-styles.min.css></head><body><div>Page <strong>not</strong> found!</div></body></html>
61 changes: 61 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# TinyWeatherForecastGermany javadoc code docs

[![gitlab pages -> pipeline status](https://gitlab.com/tinyweatherforecastgermanygroup/twfg-javadoc/badges/main/pipeline.svg)](https://gitlab.com/tinyweatherforecastgermanygroup/twfg-javadoc/-/commits/main)

[-> see here for the **docs**](https://tinyweatherforecastgermanygroup.gitlab.io/twfg-javadoc/index.html)

[-> see here for the **overview** page](https://tinyweatherforecastgermanygroup.gitlab.io/index)

## Purpose -> *Why?*

**Target:** automatically generate **code documentation** for the Project [**Tiny Weather Forecast Germany**](https://codeberg.org/Starfish/TinyWeatherForecastGermany) by Pawel Dube ([@Starfish](https://codeberg.org/Starfish)).

***Note**: 'TWFG' is an inofficial abbreviation for **T**iny **W**eather **F**orecast **G**ermany.*

## 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`](https://gitlab.com/tinyweatherforecastgermanygroup/twfg-javadoc/-/blob/c89a6b824fc2d59e0e669782251c7ca1728a8c5f/.gitlab-ci.yml) does the following:

1. update the shipped packages
2. install `graphviz` and `brotli`
3. clone the code repository from [codeberg.org](https://codeberg.org/Starfish/TinyWeatherForecastGermany) using git
4. run [`javadoc`](https://www.oracle.com/java/technologies/javase/javadoc.html) against the code repositories java files -> the [umldoclet](https://github.com/talsma-ict/umldoclet/) by [Talsma ICT](https://github.com/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](https://github.com/talsma-ict/umldoclet/) -> **graphviz**
* **brotli** and **gzip** -> compression of assets (js, css, images)

## License/Copyright and Credits

GNU **G**ENERAL **P**UBLIC **L**ICENSE (**GPLv3**) please see the [`License`](https://gitlab.com/tinyweatherforecastgermanygroup/twfg-javadoc/-/blob/456a60ab2dff26ed74a76a963f32976eb7d99066/LICENSE) file for details.

**Copyright** of the *main* project -> **Tiny Weather Forecast Germany** --> Pawel Dube ([@Starfish](https://codeberg.org/Starfish))

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

The **[GZIP](https://en.wikipedia.org/wiki/Gzip) compression** feature (high priority for SEO) was integrated using intel shared by [Christian Danscheid](https://webd97.de/post/gitlab-pages-compression/).

The [umldoclet](https://github.com/talsma-ict/umldoclet/) by [Talsma ICT](https://github.com/talsma-ict/) uses [graphviz](https://gitlab.com/graphviz/graphviz) via [PlantUML](https://plantuml.com/).

### 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'](https://codeberg.org/Starfish/TinyWeatherForecastGermany) code repository
* Please feel free to contribute to this script by opening issues and/or merge requests.
* [**Translations**](https://weblate.bubu1.eu/engage/tiny-weather-forecast-germany/) of Tiny Weather Forecast Germany are managed at the [**weblate** instance](https://weblate.bubu1.eu/projects/tiny-weather-forecast-germany/) 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)
41 changes: 41 additions & 0 deletions allclasses-index.html

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions allclasses.html

Large diffs are not rendered by default.

35 changes: 35 additions & 0 deletions allpackages-index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!DOCTYPE HTML><html lang=en> <head><meta charset=utf-8><meta content="width=device-width,initial-scale=1" name=viewport><meta content="Tiny, Weather, Forecast, Germany, source, code, Deutschland, Wetter, Vorhersage, DWD, Deutscher Wetterdienst" name=keywords><title>All Packages (Docs - TinyWeatherForecastGermany - Tiny Weather Forecast Germany)</title><meta content=2024-11-18 name=dc.created><link href=javadoc-styles.min.css rel=stylesheet type=text/css><link href=jquery/jquery-ui.min.css rel=stylesheet type=text/css><script src=script.min.js type=text/javascript></script><script src=jquery/jszip/dist/jszip.min.js type=text/javascript></script><script src=jquery/jszip-utils/dist/jszip-utils.min.js type=text/javascript></script><!--[if IE]>
<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]--><script src=jquery/jquery-3.5.1.min.js type=text/javascript></script><script src=jquery/jquery-ui.min.js type=text/javascript></script><meta content="TinyWeatherForecastGermany is an open source android app using open weather data provided by Deutscher Wetterdienst (DWD)." name=description><meta content="TinyWeatherForecastGermany - Javadoc" property=og:site_name><meta content=en_GB property=og:locale><meta content="Tiny Weather Forecast Germany - javadoc code documentation" property=og:title><meta content="TinyWeatherForecastGermany is an open source android app using open weather data provided by Deutscher Wetterdienst (DWD)." property=og:description><meta content=https://tinyweatherforecastgermanygroup.gitlab.io/index/images/twfg-repository-open-graph-graphic.png property=og:image><meta content=https://tinyweatherforecastgermanygroup.gitlab.io/twfg-javadoc/allpackages-index.html property=og:url><meta content="Tiny Weather Forecast Germany - javadoc code documentation" name=twitter:title><meta content="TinyWeatherForecastGermany is an open source android app using open weather data provided by Deutscher Wetterdienst (DWD)." name=twitter:description><meta content=https://tinyweatherforecastgermanygroup.gitlab.io/index/images/twfg-repository-open-graph-graphic.png name=twitter:image><meta content=summary_large_image name=twitter:card></head> <body> <script type=text/javascript><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="All Packages (Docs - TinyWeatherForecastGermany - Tiny Weather Forecast Germany)";
}
}
catch(err) {
}
//-->
var pathtoroot = "./";
var useModuleDirectories = false;
loadScripts(document, 'script');</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <header role=banner> <nav role=navigation> <div class=fixedNav> <div class=topNav><a id=navbar.top> </a> <div class=skipNav><a href=#skip.navbar.top title="Skip navigation links">Skip navigation links</a></div> <a id=navbar.top.firstrow> </a> <ul class=navList title=Navigation> <li><a href=index.html>Overview</a></li> <li>Package</li> <li>Class</li> <li><a href=overview-tree.html>Tree</a></li> <li><a href=deprecated-list.html>Deprecated</a></li> <li><a href=index-all.html>Index</a></li> <li><a href=help-doc.html>Help</a></li> </ul> </div> <div class=subNav> <ul class=navList id=allclasses_navbar_top> <li><a href=allclasses.html>All Classes</a></li> </ul> <ul class=navListSearch> <li><label for=search>SEARCH:</label> <input disabled=disabled id=search type=text value=search> <input disabled=disabled id=reset type=reset value=reset> </li> </ul> <div> <script type=text/javascript><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <a id=skip.navbar.top> </a></div> </div> <div class=navPadding> </div> <script type=text/javascript><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script> </nav> </header> <main role=main> <div class=header> <h1 class=title title=All&nbsp;Packages>All Packages</h1> </div> <div class=allPackagesContainer> <ul class=blockList> <li class=blockList> <table class=packagesSummary> <caption><span>Package Summary</span><span class=tabEnd> </span></caption> <tr> <th class=colFirst scope=col>Package</th> <th class=colLast scope=col>Description</th> </tr> <tbody> <tr class=altColor> <th class=colFirst scope=row><a href=de/kaffeemitkoffein/tinyweatherforecastgermany/package-summary.html>de.kaffeemitkoffein.tinyweatherforecastgermany</a></th> <td class=colLast> <div class=block>main component of TinyWeatherForecastGermany</div> </td> </tr> <tr class=rowColor> <th class=colFirst scope=row><a href=nodomain/freeyourgadget/gadgetbridge/model/package-summary.html>nodomain.freeyourgadget.gadgetbridge.model</a></th> <td class=colLast> <div class=block>contains the WeatherSpec class retrieved from Gadgetbridge</div> </td> </tr> <tr class=altColor> <th class=colFirst scope=row><a href=org/astronomie/info/package-summary.html>org.astronomie.info</a></th> <td class=colLast> <div class=block>contains a class for astronomical calculations</div> </td> </tr> </tbody> </table> </li> </ul> </div> </main> <footer role=contentinfo> <nav role=navigation> <div class=bottomNav><a id=navbar.bottom> </a> <div class=skipNav><a href=#skip.navbar.bottom title="Skip navigation links">Skip navigation links</a></div> <a id=navbar.bottom.firstrow> </a> <ul class=navList title=Navigation> <li><a href=index.html>Overview</a></li> <li>Package</li> <li>Class</li> <li><a href=overview-tree.html>Tree</a></li> <li><a href=deprecated-list.html>Deprecated</a></li> <li><a href=index-all.html>Index</a></li> <li><a href=help-doc.html>Help</a></li> </ul> <div class=aboutLanguage><p><b>License</b> <a href=https://codeberg.org/Starfish/TinyWeatherForecastGermany/src/branch/master/COPYING>GPLv3</a><br><b>Generator</b> javadocs</p></div> </div> <div class=subNav> <ul class=navList id=allclasses_navbar_bottom> <li><a href=allclasses.html>All Classes</a></li> </ul> <div> <script type=text/javascript><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> </div> <a id=skip.navbar.bottom> </a></div> </nav> <p class=legalCopy><small><p id=bottomPageText><b>Last update:</b> 2024-11-18_04:21 (UTC)     |    <span><a href=https://codeberg.org/Starfish/TinyWeatherForecastGermany>main repository at <b>codeberg.org</b></a></span>    |    <span><a href=https://gitlab.com/tinyweatherforecastgermanygroup/TinyWeatherForecastGermany>mirror repository at <b>gitlab.com</b></a></span>    |    <span><a href=https://github.com/tinyweatherforecastgermanygroup/TinyWeatherForecastGermany>mirror repository at <b>github.com</b></a></span> |    <span><a href=https://tinyweatherforecastgermanygroup.gitlab.io/index/map.html>OpenStreetMap based <b>Map</b> visualizing all data sources</a></span></p></small></p> </footer> </body> </html>
35 changes: 35 additions & 0 deletions constant-values.html

Large diffs are not rendered by default.

Loading

0 comments on commit 017c3fe

Please sign in to comment.