search

DHBW-Inf / Toolbox

Util library for the DHBW Karlsruhe programming exam.
GNU General Public License v3.0
1 stars 1 forks source link

Pipeline Update - auto docs generation #6

Open matteokosina opened 1 week ago

matteokosina commented 1 week ago

Is your feature request related to a problem? Please describe. [N/A]

Describe the util [feature] you'd like Upgrading the Github Pipeline to automatically generate docs.

Additional context For this, the builtin javadoc can be used to generate documentation. The result is a simple HTML-Doc.

habetuz commented 1 week ago

The documentation should ideally be added to releases either in the same zip as the source code or as additional zip file.

matteokosina commented 1 week ago

The documentation should ideally be added to releases either in the same zip as the source code or as additional zip file.

Should the workflow run with every merge to main trigger or should some be excluded (e.g. chore:... commits)?

habetuz commented 1 week ago

Maybe it should be added to the release workflow. Commits labeled as chore do not trigger a release. Or do you think the documentation should be updated on chore commits to?

habetuz commented 1 week ago

Besides publishing the documentation with release it could also be published via GitHub pages (in addition to the release zip file). Do you think that would be beneficial?

matteokosina commented 1 week ago

Maybe it should be added to the release workflow. Commits labeled as chore do not trigger a release. Or do you think the documentation should be updated on chore commits to?

Depends on the definition of chore: I think we are fine with not generating docs when chore only applies to maintenance work and no real code changes. :)

matteokosina commented 1 week ago

Besides publishing the documentation with release it could also be published via GitHub pages (in addition to the release zip file). Do you think that would be beneficial?

Yes why not, I can do that as well 👍