Skip to content

Auto-generate and Publish Documentation on tag creation

Chris Woodall requested to merge feature/autoupload-documentation into devel

Description

Auto-generate and Publish Documentation on tag creation. When a tag is created a documentation-job is created this job generates the documentation and uses smbclient to upload the documentation from bb8 (our build server) to sith/httpd/Burt_Documentation/burt-client-cs-<VERSION>.pdf and sith/httpd/Burt_Documentation/burt-client-cs-<VERSION> (for the html documentation).

Also added:

  • Script for generating both html and pdf documentation
  • Improved the install-dependencies script
  • Installed appropriate dependencies to docker image to speed up build time (now 10-20 seconds versus 3 minutes).

NOTE: The tag MUST be an annotated tag otherwise the git revision will be used instead.

What to focus on

  • Correctness of documentation and method.

Reviewers

Resources

See the following example outputs and URLs:

Issues

What issues does this fix?

  • Fixes None

Merge request reports