[Issue: #6] Added pipeline for automated docs generation - Githubissues

DHBW-Inf / Toolbox

Util library for the DHBW Karlsruhe programming exam.

GNU General Public License v3.0

2 stars 3 forks source link

[Issue: #6] Added pipeline for automated docs generation #11

Closed matteokosina closed 1 month ago

matteokosina commented 2 months ago

Description of Changes

Added new functionality to the release pipeline to auto-generate java docs when a new release is created.

Verify

[x] The PR does not involve breaking changes, or the corresponding developers are informed and mentioned under "Reference"
[x] Unit tests were added if needed
[ ] The code that is being added, was tested and no faults were found
[x] The code that is being added, does not require external dependencies

Reference

6
FYI: @habetuz , could involve breaking changes

Additional Context

When the workflow is triggered, it creates a ./docs folder and generates a java documentation using maven and javadoc inside.

The newly created doc is then copied over to a branch called docs-deployment , from which it can later be deployed to GitHub Pages solely